[libc] Add lgamma and lgamma_r stubs for the GPU (#102019)

jhuber6 · web-flow · commit 88d288489e09 · 2024-08-05T14:53:05.000-05:00
Summary:
These functions are used by the &lt;random&gt; implementation in libc++ and
cause a lot of tests to fail. For now we provide these through the
vendor abstraction until we have a real version. The NVPTX version
doesn't even update the output correctly so these are just temporary.
diff --git a/libc/config/gpu/entrypoints.txt b/libc/config/gpu/entrypoints.txt
@@ -349,6 +349,8 @@ set(TARGET_LIBM_ENTRYPOINTS
     libc.src.math.tanhf
     libc.src.math.tgamma
     libc.src.math.tgammaf
+    libc.src.math.lgamma
+    libc.src.math.lgamma_r
     libc.src.math.trunc
     libc.src.math.truncf
 )
diff --git a/libc/newhdrgen/yaml/math.yaml b/libc/newhdrgen/yaml/math.yaml
@@ -2153,3 +2153,42 @@ functions:
       - type: int
       - type: unsigned int
     guard: LIBC_TYPES_HAS_FLOAT128
+  - name: lgamma
+    standards: 
+      - stdc
+    return_type: double
+    arguments:
+      - type: double
+  - name: lgammaf
+    standards: 
+      - stdc
+    return_type: float
+    arguments:
+      - type: float
+  - name: lgammal
+    standards: 
+      - stdc
+    return_type: long double
+    arguments:
+      - type: long double
+  - name: lgamma_r
+    standards: 
+      - gnu
+    return_type: double
+    arguments:
+      - type: double
+      - type: int *
+  - name: lgammaf_r
+    standards: 
+      - gnu
+    return_type: float
+    arguments:
+      - type: float
+      - type: int *
+  - name: lgammal_r
+    standards: 
+      - gnu
+    return_type: long double
+    arguments:
+      - type: long double
+      - type: int *
diff --git a/libc/spec/gnu_ext.td b/libc/spec/gnu_ext.td
@@ -33,6 +33,21 @@ def GnuExtensions : StandardSpec<"GNUExtensions"> {
             RetValSpec<VoidType>,
             [ArgSpec<FloatType>, ArgSpec<FloatPtr>, ArgSpec<FloatPtr>]
         >,
+        FunctionSpec<
+            "lgamma_r",
+            RetValSpec<DoubleType>,
+            [ArgSpec<DoubleType, IntPtr>]
+        >,
+        FunctionSpec<
+            "lgammaf_r",
+            RetValSpec<FloatType>,
+            [ArgSpec<FloatType, IntPtr>]
+        >,
+        FunctionSpec<
+            "lgammal_r",
+            RetValSpec<LongDoubleType>,
+            [ArgSpec<LongDoubleType, IntPtr>]
+        >,
       ]
   >;
 
diff --git a/libc/spec/stdc.td b/libc/spec/stdc.td
@@ -767,6 +767,10 @@ def StdC : StandardSpec<"stdc"> {
           GuardedFunctionSpec<"f16divf128", RetValSpec<Float16Type>, [ArgSpec<Float128Type>, ArgSpec<Float128Type>], "LIBC_TYPES_HAS_FLOAT16_AND_FLOAT128">,
 
           GuardedFunctionSpec<"f16sqrtf128", RetValSpec<Float16Type>, [ArgSpec<Float128Type>], "LIBC_TYPES_HAS_FLOAT16_AND_FLOAT128">,
+
+          FunctionSpec<"lgamma", RetValSpec<DoubleType>, [ArgSpec<DoubleType>]>,
+          FunctionSpec<"lgammaf", RetValSpec<FloatType>, [ArgSpec<FloatType>]>,
+          FunctionSpec<"lgammal", RetValSpec<LongDoubleType>, [ArgSpec<LongDoubleType>]>,
       ]
   >;
 
diff --git a/libc/src/math/CMakeLists.txt b/libc/src/math/CMakeLists.txt
@@ -448,6 +448,8 @@ add_math_entrypoint_object(tanhf)
 
 add_math_entrypoint_object(tgamma)
 add_math_entrypoint_object(tgammaf)
+add_math_entrypoint_object(lgamma)
+add_math_entrypoint_object(lgamma_r)
 
 add_math_entrypoint_object(totalorder)
 add_math_entrypoint_object(totalorderf)
diff --git a/libc/src/math/amdgpu/CMakeLists.txt b/libc/src/math/amdgpu/CMakeLists.txt
@@ -515,3 +515,27 @@ add_entrypoint_object(
     -O2
   VENDOR
 )
+
+add_entrypoint_object(
+  lgamma
+  SRCS
+    lgamma.cpp
+  HDRS
+    ../lgamma.h
+  COMPILE_OPTIONS
+    ${bitcode_link_flags}
+    -O2
+  VENDOR
+)
+
+add_entrypoint_object(
+  lgamma_r
+  SRCS
+    lgamma_r.cpp
+  HDRS
+    ../lgamma_r.h
+  COMPILE_OPTIONS
+    ${bitcode_link_flags}
+    -O2
+  VENDOR
+)
diff --git a/libc/src/math/amdgpu/declarations.h b/libc/src/math/amdgpu/declarations.h
@@ -82,6 +82,8 @@ float __ocml_remquo_f32(float, float, gpu::Private<int> *);
 double __ocml_remquo_f64(double, double, gpu::Private<int> *);
 double __ocml_tgamma_f64(double);
 float __ocml_tgamma_f32(float);
+double __ocml_lgamma_f64(double);
+double __ocml_lgamma_r_f64(double, gpu::Private<int> *);
 }
 
 } // namespace LIBC_NAMESPACE_DECL
diff --git a/libc/src/math/amdgpu/lgamma.cpp b/libc/src/math/amdgpu/lgamma.cpp
@@ -0,0 +1,19 @@
+//===-- Implementation of the lgamma function for GPU ---------------------===//
+//
+// 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/lgamma.h"
+#include "src/__support/common.h"
+
+#include "declarations.h"
+#include "src/__support/macros/config.h"
+
+namespace LIBC_NAMESPACE_DECL {
+
+LLVM_LIBC_FUNCTION(double, lgamma, (double x)) { return __ocml_lgamma_f64(x); }
+
+} // namespace LIBC_NAMESPACE_DECL
diff --git a/libc/src/math/amdgpu/lgamma_r.cpp b/libc/src/math/amdgpu/lgamma_r.cpp
@@ -0,0 +1,24 @@
+//===-- Implementation of the lgamma_r function for GPU -------------------===//
+//
+// 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/lgamma_r.h"
+#include "src/__support/common.h"
+
+#include "declarations.h"
+#include "src/__support/macros/config.h"
+
+namespace LIBC_NAMESPACE_DECL {
+
+LLVM_LIBC_FUNCTION(double, lgamma_r, (double x, int *signp)) {
+  int tmp = *signp;
+  double r = __ocml_lgamma_r_f64(x, (gpu::Private<int> *)&tmp);
+  *signp = tmp;
+  return r;
+}
+
+} // namespace LIBC_NAMESPACE_DECL
diff --git a/libc/src/math/lgamma.h b/libc/src/math/lgamma.h
@@ -0,0 +1,20 @@
+//===-- Implementation header for lgamma ------------------------*- 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_LGAMMA_H
+#define LLVM_LIBC_SRC_MATH_LGAMMA_H
+
+#include "src/__support/macros/config.h"
+
+namespace LIBC_NAMESPACE_DECL {
+
+double lgamma(double x);
+
+} // namespace LIBC_NAMESPACE_DECL
+
+#endif // LLVM_LIBC_SRC_MATH_LGAMMA_H
diff --git a/libc/src/math/lgamma_r.h b/libc/src/math/lgamma_r.h
@@ -0,0 +1,20 @@
+//===-- Implementation header for lgamma_r-----------------------*- 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_LGAMMA_R_H
+#define LLVM_LIBC_SRC_MATH_LGAMMA_R_H
+
+#include "src/__support/macros/config.h"
+
+namespace LIBC_NAMESPACE_DECL {
+
+double lgamma_r(double x, int *signp);
+
+} // namespace LIBC_NAMESPACE_DECL
+
+#endif // LLVM_LIBC_SRC_MATH_LGAMMA_R_H
diff --git a/libc/src/math/nvptx/CMakeLists.txt b/libc/src/math/nvptx/CMakeLists.txt
@@ -468,3 +468,27 @@ add_entrypoint_object(
     -O2
   VENDOR
 )
+
+add_entrypoint_object(
+  lgamma
+  SRCS
+    lgamma.cpp
+  HDRS
+    ../lgamma.h
+  COMPILE_OPTIONS
+    ${bitcode_link_flags}
+    -O2
+  VENDOR
+)
+
+add_entrypoint_object(
+  lgamma_r
+  SRCS
+    lgamma_r.cpp
+  HDRS
+    ../lgamma_r.h
+  COMPILE_OPTIONS
+    ${bitcode_link_flags}
+    -O2
+  VENDOR
+)
diff --git a/libc/src/math/nvptx/declarations.h b/libc/src/math/nvptx/declarations.h
@@ -86,6 +86,7 @@ double __nv_remquo(double, double, int *);
 float __nv_remquof(float, float, int *);
 double __nv_tgamma(double);
 float __nv_tgammaf(float);
+float __nv_lgamma(double);
 }
 
 } // namespace LIBC_NAMESPACE_DECL
diff --git a/libc/src/math/nvptx/lgamma.cpp b/libc/src/math/nvptx/lgamma.cpp
@@ -0,0 +1,19 @@
+//===-- Implementation of the lgamma function for GPU ---------------------===//
+//
+// 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/lgamma.h"
+#include "src/__support/common.h"
+
+#include "declarations.h"
+#include "src/__support/macros/config.h"
+
+namespace LIBC_NAMESPACE_DECL {
+
+LLVM_LIBC_FUNCTION(double, lgamma, (double x)) { return __nv_lgamma(x); }
+
+} // namespace LIBC_NAMESPACE_DECL
diff --git a/libc/src/math/nvptx/lgamma_r.cpp b/libc/src/math/nvptx/lgamma_r.cpp
@@ -0,0 +1,23 @@
+//===-- Implementation of the lgamma_r function for GPU -------------------===//
+//
+// 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/lgamma_r.h"
+#include "src/__support/common.h"
+
+#include "declarations.h"
+#include "src/__support/macros/config.h"
+
+namespace LIBC_NAMESPACE_DECL {
+
+LLVM_LIBC_FUNCTION(double, lgamma_r, (double x, int *signp)) {
+  double result = __nv_lgamma(x);
+  *signp = (result < 0.0) ? -1 : 1;
+  return result;
+}
+
+} // namespace LIBC_NAMESPACE_DECL

Original file line number	Diff line number	Diff line change
`@@ -349,6 +349,8 @@ set(TARGET_LIBM_ENTRYPOINTS`
`349`	`349`	`libc.src.math.tanhf`
`350`	`350`	`libc.src.math.tgamma`
`351`	`351`	`libc.src.math.tgammaf`
	`352`	`+ libc.src.math.lgamma`
	`353`	`+ libc.src.math.lgamma_r`
`352`	`354`	`libc.src.math.trunc`
`353`	`355`	`libc.src.math.truncf`
`354`	`356`	`)`
Original file line number	Diff line number	Diff line change
`@@ -767,6 +767,10 @@ def StdC : StandardSpec<"stdc"> {`
`767`	`767`	`GuardedFunctionSpec<"f16divf128", RetValSpec<Float16Type>, [ArgSpec<Float128Type>, ArgSpec<Float128Type>], "LIBC_TYPES_HAS_FLOAT16_AND_FLOAT128">,`
`768`	`768`
`769`	`769`	`GuardedFunctionSpec<"f16sqrtf128", RetValSpec<Float16Type>, [ArgSpec<Float128Type>], "LIBC_TYPES_HAS_FLOAT16_AND_FLOAT128">,`
	`770`	`+`
	`771`	`+ FunctionSpec<"lgamma", RetValSpec<DoubleType>, [ArgSpec<DoubleType>]>,`
	`772`	`+ FunctionSpec<"lgammaf", RetValSpec<FloatType>, [ArgSpec<FloatType>]>,`
	`773`	`+ FunctionSpec<"lgammal", RetValSpec<LongDoubleType>, [ArgSpec<LongDoubleType>]>,`
`770`	`774`	`]`
`771`	`775`	`>;`
`772`	`776`
Original file line number	Diff line number	Diff line change
`@@ -82,6 +82,8 @@ float __ocml_remquo_f32(float, float, gpu::Private<int> *);`
`82`	`82`	`double __ocml_remquo_f64(double, double, gpu::Private<int> *);`
`83`	`83`	`double __ocml_tgamma_f64(double);`
`84`	`84`	`float __ocml_tgamma_f32(float);`
	`85`	`+double __ocml_lgamma_f64(double);`
	`86`	`+double __ocml_lgamma_r_f64(double, gpu::Private<int> *);`
`85`	`87`	`}`
`86`	`88`
`87`	`89`	`} // namespace LIBC_NAMESPACE_DECL`
Original file line number	Diff line number	Diff line change
`@@ -86,6 +86,7 @@ double __nv_remquo(double, double, int *);`
`86`	`86`	`float __nv_remquof(float, float, int *);`
`87`	`87`	`double __nv_tgamma(double);`
`88`	`88`	`float __nv_tgammaf(float);`
	`89`	`+float __nv_lgamma(double);`
`89`	`90`	`}`
`90`	`91`
`91`	`92`	`} // namespace LIBC_NAMESPACE_DECL`