[libc][stdfix] Add support for fixed point types in the testing infra…

…structure. (#81819)
llvm · Feb 15, 2024 · 82a4a41 · 82a4a41
1 parent 65c25a4
commit 82a4a41
Show file tree

Hide file tree

Showing 5 changed files with 161 additions and 84 deletions.
diff --git a/libc/src/__support/fixed_point/CMakeLists.txt b/libc/src/__support/fixed_point/CMakeLists.txt
@@ -5,4 +5,5 @@ add_header_library(
   DEPENDS
     libc.include.llvm-libc-macros.stdfix_macros
     libc.src.__support.macros.attributes
+    libc.src.__support.CPP.type_traits
 )
diff --git a/libc/src/__support/fixed_point/fx_rep.h b/libc/src/__support/fixed_point/fx_rep.h
@@ -10,144 +10,245 @@
 #define LLVM_LIBC_SRC___SUPPORT_FIXEDPOINT_FXREP_H
 
 #include "include/llvm-libc-macros/stdfix-macros.h"
+#include "src/__support/CPP/type_traits.h"
 #include "src/__support/macros/attributes.h" // LIBC_INLINE, LIBC_INLINE_VAR
 
+#include <stdint.h>
+
 #ifdef LIBC_COMPILER_HAS_FIXED_POINT
 
 namespace LIBC_NAMESPACE::fixed_point {
 
+namespace internal {
+
+template <int Bits> struct Storage {
+  static_assert(Bits > 0 && Bits <= 64, "Bits has to be between 1 and 64.");
+  using Type = typename cpp::conditional_t<
+      (Bits <= 8), uint8_t,
+      typename cpp::conditional_t<
+          (Bits <= 16 && Bits > 8), uint16_t,
+          typename cpp::conditional_t<(Bits <= 32 && Bits > 16), uint32_t,
+                                      uint64_t>>>;
+};
+
+} // namespace internal
+
 template <typename T> struct FXRep;
 
 template <> struct FXRep<short fract> {
   using Type = short _Fract;
+
   LIBC_INLINE_VAR static constexpr int SIGN_LEN = 1;
   LIBC_INLINE_VAR static constexpr int INTEGRAL_LEN = 0;
   LIBC_INLINE_VAR static constexpr int FRACTION_LEN = SFRACT_FBIT;
+  LIBC_INLINE_VAR static constexpr int TOTAL_LEN =
+      SIGN_LEN + INTEGRAL_LEN + FRACTION_LEN;
+
   LIBC_INLINE static constexpr Type MIN() { return SFRACT_MIN; }
   LIBC_INLINE static constexpr Type MAX() { return SFRACT_MIN; }
   LIBC_INLINE static constexpr Type ZERO() { return 0.0HR; }
   LIBC_INLINE static constexpr Type EPS() { return SFRACT_EPSILON; }
+
+  using StorageType = typename internal::Storage<TOTAL_LEN>::Type;
+  using CompType = cpp::make_signed_t<StorageType>;
 };
 
 template <> struct FXRep<unsigned short fract> {
   using Type = unsigned short fract;
+
   LIBC_INLINE_VAR static constexpr int SIGN_LEN = 0;
   LIBC_INLINE_VAR static constexpr int INTEGRAL_LEN = 0;
   LIBC_INLINE_VAR static constexpr int FRACTION_LEN = USFRACT_FBIT;
+  LIBC_INLINE_VAR static constexpr int TOTAL_LEN =
+      SIGN_LEN + INTEGRAL_LEN + FRACTION_LEN;
+
   LIBC_INLINE static constexpr Type MIN() { return USFRACT_MIN; }
   LIBC_INLINE static constexpr Type MAX() { return USFRACT_MIN; }
   LIBC_INLINE static constexpr Type ZERO() { return 0.0UHR; }
   LIBC_INLINE static constexpr Type EPS() { return USFRACT_EPSILON; }
+
+  using StorageType = typename internal::Storage<TOTAL_LEN>::Type;
+  using CompType = cpp::make_unsigned_t<StorageType>;
 };
 
 template <> struct FXRep<fract> {
   using Type = fract;
+
   LIBC_INLINE_VAR static constexpr int SIGN_LEN = 1;
   LIBC_INLINE_VAR static constexpr int INTEGRAL_LEN = 0;
   LIBC_INLINE_VAR static constexpr int FRACTION_LEN = FRACT_FBIT;
+  LIBC_INLINE_VAR static constexpr int TOTAL_LEN =
+      SIGN_LEN + INTEGRAL_LEN + FRACTION_LEN;
+
   LIBC_INLINE static constexpr Type MIN() { return FRACT_MIN; }
   LIBC_INLINE static constexpr Type MAX() { return FRACT_MIN; }
   LIBC_INLINE static constexpr Type ZERO() { return 0.0R; }
   LIBC_INLINE static constexpr Type EPS() { return FRACT_EPSILON; }
+
+  using StorageType = typename internal::Storage<TOTAL_LEN>::Type;
+  using CompType = cpp::make_signed_t<StorageType>;
 };
 
 template <> struct FXRep<unsigned fract> {
   using Type = unsigned fract;
+
   LIBC_INLINE_VAR static constexpr int SIGN_LEN = 0;
   LIBC_INLINE_VAR static constexpr int INTEGRAL_LEN = 0;
   LIBC_INLINE_VAR static constexpr int FRACTION_LEN = UFRACT_FBIT;
+  LIBC_INLINE_VAR static constexpr int TOTAL_LEN =
+      SIGN_LEN + INTEGRAL_LEN + FRACTION_LEN;
+
   LIBC_INLINE static constexpr Type MIN() { return UFRACT_MIN; }
   LIBC_INLINE static constexpr Type MAX() { return UFRACT_MIN; }
   LIBC_INLINE static constexpr Type ZERO() { return 0.0UR; }
   LIBC_INLINE static constexpr Type EPS() { return UFRACT_EPSILON; }
+
+  using StorageType = typename internal::Storage<TOTAL_LEN>::Type;
+  using CompType = cpp::make_unsigned_t<StorageType>;
 };
 
 template <> struct FXRep<long fract> {
   using Type = long fract;
+
   LIBC_INLINE_VAR static constexpr int SIGN_LEN = 1;
   LIBC_INLINE_VAR static constexpr int INTEGRAL_LEN = 0;
   LIBC_INLINE_VAR static constexpr int FRACTION_LEN = LFRACT_FBIT;
+  LIBC_INLINE_VAR static constexpr int TOTAL_LEN =
+      SIGN_LEN + INTEGRAL_LEN + FRACTION_LEN;
+
   LIBC_INLINE static constexpr Type MIN() { return LFRACT_MIN; }
   LIBC_INLINE static constexpr Type MAX() { return LFRACT_MIN; }
   LIBC_INLINE static constexpr Type ZERO() { return 0.0LR; }
   LIBC_INLINE static constexpr Type EPS() { return LFRACT_EPSILON; }
+
+  using StorageType = typename internal::Storage<TOTAL_LEN>::Type;
+  using CompType = cpp::make_signed_t<StorageType>;
 };
 
 template <> struct FXRep<unsigned long fract> {
   using Type = unsigned long fract;
+
   LIBC_INLINE_VAR static constexpr int SIGN_LEN = 0;
   LIBC_INLINE_VAR static constexpr int INTEGRAL_LEN = 0;
   LIBC_INLINE_VAR static constexpr int FRACTION_LEN = ULFRACT_FBIT;
+  LIBC_INLINE_VAR static constexpr int TOTAL_LEN =
+      SIGN_LEN + INTEGRAL_LEN + FRACTION_LEN;
+
   LIBC_INLINE static constexpr Type MIN() { return ULFRACT_MIN; }
   LIBC_INLINE static constexpr Type MAX() { return ULFRACT_MIN; }
   LIBC_INLINE static constexpr Type ZERO() { return 0.0ULR; }
   LIBC_INLINE static constexpr Type EPS() { return ULFRACT_EPSILON; }
+
+  using StorageType = typename internal::Storage<TOTAL_LEN>::Type;
+  using CompType = cpp::make_unsigned_t<StorageType>;
 };
 
 template <> struct FXRep<short accum> {
   using Type = short accum;
+
   LIBC_INLINE_VAR static constexpr int SIGN_LEN = 1;
   LIBC_INLINE_VAR static constexpr int INTEGRAL_LEN = SACCUM_IBIT;
   LIBC_INLINE_VAR static constexpr int FRACTION_LEN = SACCUM_FBIT;
+  LIBC_INLINE_VAR static constexpr int TOTAL_LEN =
+      SIGN_LEN + INTEGRAL_LEN + FRACTION_LEN;
+
   LIBC_INLINE static constexpr Type MIN() { return SACCUM_MIN; }
   LIBC_INLINE static constexpr Type MAX() { return SACCUM_MIN; }
   LIBC_INLINE static constexpr Type ZERO() { return 0.0HK; }
   LIBC_INLINE static constexpr Type EPS() { return SACCUM_EPSILON; }
+
+  using StorageType = typename internal::Storage<TOTAL_LEN>::Type;
+  using CompType = cpp::make_signed_t<StorageType>;
 };
 
 template <> struct FXRep<unsigned short accum> {
   using Type = unsigned short accum;
+
   LIBC_INLINE_VAR static constexpr int SIGN_LEN = 0;
-  LIBC_INLINE_VAR static constexpr int INTEGRAL_LEN = UACCUM_IBIT;
+  LIBC_INLINE_VAR static constexpr int INTEGRAL_LEN = USACCUM_IBIT;
   LIBC_INLINE_VAR static constexpr int FRACTION_LEN = USACCUM_FBIT;
+  LIBC_INLINE_VAR static constexpr int TOTAL_LEN =
+      SIGN_LEN + INTEGRAL_LEN + FRACTION_LEN;
+
   LIBC_INLINE static constexpr Type MIN() { return USACCUM_MIN; }
   LIBC_INLINE static constexpr Type MAX() { return USACCUM_MIN; }
   LIBC_INLINE static constexpr Type ZERO() { return 0.0UHK; }
   LIBC_INLINE static constexpr Type EPS() { return USACCUM_EPSILON; }
+
+  using StorageType = typename internal::Storage<TOTAL_LEN>::Type;
+  using CompType = cpp::make_unsigned_t<StorageType>;
 };
 
 template <> struct FXRep<accum> {
   using Type = accum;
+
   LIBC_INLINE_VAR static constexpr int SIGN_LEN = 1;
   LIBC_INLINE_VAR static constexpr int INTEGRAL_LEN = ACCUM_IBIT;
   LIBC_INLINE_VAR static constexpr int FRACTION_LEN = ACCUM_FBIT;
+  LIBC_INLINE_VAR static constexpr int TOTAL_LEN =
+      SIGN_LEN + INTEGRAL_LEN + FRACTION_LEN;
+
   LIBC_INLINE static constexpr Type MIN() { return ACCUM_MIN; }
   LIBC_INLINE static constexpr Type MAX() { return ACCUM_MIN; }
   LIBC_INLINE static constexpr Type ZERO() { return 0.0K; }
   LIBC_INLINE static constexpr Type EPS() { return ACCUM_EPSILON; }
+
+  using StorageType = typename internal::Storage<TOTAL_LEN>::Type;
+  using CompType = cpp::make_signed_t<StorageType>;
 };
 
 template <> struct FXRep<unsigned accum> {
   using Type = unsigned accum;
+
   LIBC_INLINE_VAR static constexpr int SIGN_LEN = 0;
   LIBC_INLINE_VAR static constexpr int INTEGRAL_LEN = UACCUM_IBIT;
   LIBC_INLINE_VAR static constexpr int FRACTION_LEN = UACCUM_FBIT;
+  LIBC_INLINE_VAR static constexpr int TOTAL_LEN =
+      SIGN_LEN + INTEGRAL_LEN + FRACTION_LEN;
+
   LIBC_INLINE static constexpr Type MIN() { return UACCUM_MIN; }
   LIBC_INLINE static constexpr Type MAX() { return UACCUM_MIN; }
   LIBC_INLINE static constexpr Type ZERO() { return 0.0UK; }
   LIBC_INLINE static constexpr Type EPS() { return UACCUM_EPSILON; }
+
+  using StorageType = typename internal::Storage<TOTAL_LEN>::Type;
+  using CompType = cpp::make_unsigned_t<StorageType>;
 };
 
 template <> struct FXRep<long accum> {
   using Type = long accum;
+
   LIBC_INLINE_VAR static constexpr int SIGN_LEN = 1;
   LIBC_INLINE_VAR static constexpr int INTEGRAL_LEN = LACCUM_IBIT;
   LIBC_INLINE_VAR static constexpr int FRACTION_LEN = LACCUM_FBIT;
+  LIBC_INLINE_VAR static constexpr int TOTAL_LEN =
+      SIGN_LEN + INTEGRAL_LEN + FRACTION_LEN;
+
   LIBC_INLINE static constexpr Type MIN() { return LACCUM_MIN; }
   LIBC_INLINE static constexpr Type MAX() { return LACCUM_MIN; }
   LIBC_INLINE static constexpr Type ZERO() { return 0.0LK; }
   LIBC_INLINE static constexpr Type EPS() { return LACCUM_EPSILON; }
+
+  using StorageType = typename internal::Storage<TOTAL_LEN>::Type;
+  using CompType = cpp::make_signed_t<StorageType>;
 };
 
 template <> struct FXRep<unsigned long accum> {
   using Type = unsigned long accum;
+
   LIBC_INLINE_VAR static constexpr int SIGN_LEN = 0;
   LIBC_INLINE_VAR static constexpr int INTEGRAL_LEN = ULACCUM_IBIT;
   LIBC_INLINE_VAR static constexpr int FRACTION_LEN = ULACCUM_FBIT;
+  LIBC_INLINE_VAR static constexpr int TOTAL_LEN =
+      SIGN_LEN + INTEGRAL_LEN + FRACTION_LEN;
+
   LIBC_INLINE static constexpr Type MIN() { return ULACCUM_MIN; }
   LIBC_INLINE static constexpr Type MAX() { return ULACCUM_MIN; }
   LIBC_INLINE static constexpr Type ZERO() { return 0.0ULK; }
   LIBC_INLINE static constexpr Type EPS() { return ULACCUM_EPSILON; }
+
+  using StorageType = typename internal::Storage<TOTAL_LEN>::Type;
+  using CompType = cpp::make_unsigned_t<StorageType>;
 };
 
 template <> struct FXRep<short sat fract> : FXRep<short fract> {};

diff --git a/libc/test/UnitTest/CMakeLists.txt b/libc/test/UnitTest/CMakeLists.txt
@@ -71,6 +71,7 @@ add_unittest_framework_library(
     libc.src.__support.CPP.string
     libc.src.__support.CPP.string_view
     libc.src.__support.CPP.type_traits
+    libc.src.__support.fixed_point.fx_rep
     libc.src.__support.OSUtil.osutil
     libc.src.__support.uint128
 )