[libc] Add sqrtf128 implementation for Linux x86_64. (#79195)

Co-authored-by: Tue Ly <[email protected]>
Co-authored-by: Felix <[email protected]>

Author: 3 people

libc/config/linux/x86_64/entrypoints.txt

@@ -374,6 +374,7 @@ if(LIBC_COMPILER_HAS_FLOAT128)
     # math.h C23 _Float128 entrypoints
     libc.src.math.copysignf128
     libc.src.math.fabsf128
+    libc.src.math.sqrtf128
   )
 endif()
 

libc/docs/math/index.rst

@@ -452,6 +452,8 @@ Higher Math Functions
 +------------+---------+---------+---------+---------+---------+---------+---------+---------+---------+---------+---------+---------+
 | sqrtl      | |check| | |check| | |check| | |check| | |check| |         |         | |check| | |check| | |check| |         |         |
 +------------+---------+---------+---------+---------+---------+---------+---------+---------+---------+---------+---------+---------+
+| sqrtf128   | |check| |         |         |         |         |         |         |         |         |         |         |         |
++------------+---------+---------+---------+---------+---------+---------+---------+---------+---------+---------+---------+---------+
 | tan        | |check| |         |         |         |         |         |         |         |         |         |         |         |
 +------------+---------+---------+---------+---------+---------+---------+---------+---------+---------+---------+---------+---------+
 | tanf       | |check| | |check| | |check| | |check| | |check| |         |         | |check| | |check| | |check| |         |         |
@@ -475,9 +477,9 @@ Higher Math Functions
 Accuracy of Higher Math Functions
 =================================
 
-============== ================ =============== ======================
-<Func>         <Func_f> (float) <Func> (double) <Func_l> (long double)
-============== ================ =============== ======================
+============== ================ =============== ====================== ======================
+<Func>         <Func_f> (float) <Func> (double) <Func_l> (long double) <Func_f128> (float128)
+============== ================ =============== ====================== ======================
 acos           |check|
 acosh          |check|
 asin           |check|
@@ -501,10 +503,10 @@ pow            |check|
 sin            |check|          large
 sincos         |check|          large
 sinh           |check|
-sqrt           |check|          |check|         |check|
+sqrt           |check|          |check|         |check|                |check|
 tan            |check|
 tanh           |check|
-============== ================ =============== ======================
+============== ================ =============== ====================== ======================
 
 
 Legends:

libc/spec/stdc.td

@@ -480,6 +480,7 @@ def StdC : StandardSpec<"stdc"> {
           FunctionSpec<"sqrt", RetValSpec<DoubleType>, [ArgSpec<DoubleType>]>,
           FunctionSpec<"sqrtf", RetValSpec<FloatType>, [ArgSpec<FloatType>]>,
           FunctionSpec<"sqrtl", RetValSpec<LongDoubleType>, [ArgSpec<LongDoubleType>]>,
+          FunctionSpec<"sqrtf128", RetValSpec<Float128Type>, [ArgSpec<Float128Type>]>, 
 
           FunctionSpec<"trunc", RetValSpec<DoubleType>, [ArgSpec<DoubleType>]>,
           FunctionSpec<"truncf", RetValSpec<FloatType>, [ArgSpec<FloatType>]>,

libc/src/math/CMakeLists.txt

@@ -231,6 +231,7 @@ add_math_entrypoint_object(sinhf)
 add_math_entrypoint_object(sqrt)
 add_math_entrypoint_object(sqrtf)
 add_math_entrypoint_object(sqrtl)
+add_math_entrypoint_object(sqrtf128)
 
 add_math_entrypoint_object(tan)
 add_math_entrypoint_object(tanf)

libc/src/math/generic/CMakeLists.txt

@@ -1315,6 +1315,18 @@ add_entrypoint_object(
     -O3
 )
 
+add_entrypoint_object(
+  sqrtf128
+  SRCS
+    sqrtf128.cpp
+  HDRS
+    ../sqrtf128.h
+  DEPENDS
+    libc.src.__support.FPUtil.sqrt 
+  COMPILE_OPTIONS
+    -O3
+  )
+
 add_entrypoint_object(
   remquof
   SRCS

libc/src/math/generic/sqrtf128.cpp

@@ -0,0 +1,17 @@
+//===-- Implementation of sqrtf128 function -------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+#include "src/math/sqrtf128.h"
+#include "src/__support/FPUtil/sqrt.h"
+#include "src/__support/common.h"
+
+namespace LIBC_NAMESPACE {
+
+LLVM_LIBC_FUNCTION(float128, sqrtf128, (float128 x)) { return fputil::sqrt(x); }
+
+} // namespace LIBC_NAMESPACE

libc/src/math/sqrtf128.h

@@ -0,0 +1,20 @@
+//===-- Implementation header for sqrtf128 ----------------------*- 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_MATH_SQRTF128_H
+#define LLVM_LIBC_SRC_MATH_SQRTF128_H
+
+#include "src/__support/macros/properties/float.h"
+
+namespace LIBC_NAMESPACE {
+
+float128 sqrtf128(float128 x);
+
+} // namespace LIBC_NAMESPACE
+
+#endif // LLVM_LIBC_SRC_MATH_SQRTF128_H

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

@@ -1102,6 +1102,20 @@ add_fp_unittest(
   UNIT_TEST_ONLY
 )
 
+add_fp_unittest(
+  sqrtf128_test
+  SUITE
+    libc-math-smoke-tests
+  SRCS
+    sqrtf128_test.cpp
+  DEPENDS
+    libc.include.math
+    libc.src.math.sqrtf128
+    libc.src.__support.FPUtil.fp_bits
+  # FIXME: Currently fails on the GPU build.
+  UNIT_TEST_ONLY
+)
+
 add_fp_unittest(
   generic_sqrtf_test
   SUITE
@@ -1150,6 +1164,22 @@ add_fp_unittest(
   UNIT_TEST_ONLY
 )
 
+add_fp_unittest(
+  generic_sqrtf128_test
+  SUITE
+    libc-math-smoke-tests
+  SRCS
+    generic_sqrtf128_test.cpp
+  DEPENDS
+    libc.src.math.sqrtf128
+    libc.src.__support.FPUtil.fp_bits
+    libc.src.__support.FPUtil.generic.sqrt
+  COMPILE_OPTIONS
+    -O3
+  # FIXME: Currently fails on the GPU build.
+  UNIT_TEST_ONLY
+)
+
 add_fp_unittest(
   remquof_test
   SUITE

libc/test/src/math/smoke/generic_sqrtf128_test.cpp

@@ -0,0 +1,13 @@
+//===-- Unittests for generic implementation of sqrtf128-------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+#include "SqrtTest.h"
+
+#include "src/__support/FPUtil/generic/sqrt.h"
+
+LIST_SQRT_TESTS(float128, LIBC_NAMESPACE::fputil::sqrt<float128>)

libc/test/src/math/smoke/sqrtf128_test.cpp

@@ -0,0 +1,13 @@
+//===-- Unittests for sqrtf128---------------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+#include "SqrtTest.h"
+
+#include "src/math/sqrtf128.h"
+
+LIST_SQRT_TESTS(float128, LIBC_NAMESPACE::sqrtf128)