libstdc++: Implement std::atomic::fetch_min/max

This patch extends libstdc++ to implement C++26's atomic fetch min/max
operations.

The __atomic_fetch_minmaxable concept checks if __atomic_fetch_min and
__atomic_fetch_max builtins are implemented by the compiler. If not, fall back
to a CAS loop.

This patch was bootstrapped and regtested on aarch64-linux-gnu and
x86_64-linux-gnu, no regression.

Signed-off-by: Soumya AR <soumyaa@nvidia.com>
libstdc++-v3/ChangeLog:

	* include/bits/atomic_base.h:
	Add fetch_min and fetch_max memberfunctions.
	* include/bits/version.def:
	Add __cpp_lib_atomic_min_max feature test macro.
	* include/bits/version.h (defined): Regenerate.
	* include/std/atomic: Extend for fetch_min/max non-member functions.
	* src/c++23/std.cc.in: Export atomic_fetch_min, atomic_fetch_max,
	atomic_fetch_min_explicit, atomic_fetch_max_explicit.
	* testsuite/29_atomics/atomic_integral/nonmembers_fetch_minmax.cc:
	New test.
	* testsuite/29_atomics/atomic_ref/integral_fetch_minmax.cc: New test.

diff --git a/libstdc++-v3/include/bits/atomic_base.h b/libstdc++-v3/include/bits/atomic_base.h
index 92545902111fdd70ac9c0500ff37f9d29ab21548..bc4778f08cb1a2f5a2a3d246ec138afef51c79a0 100644 (file)
--- a/libstdc++-v3/include/bits/atomic_base.h
+++ b/libstdc++-v3/include/bits/atomic_base.h
@@ -334,6 +334,23 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
   // NB: Assuming _ITp is an integral scalar type that is 1, 2, 4, or
   // 8 bytes, since that is what GCC built-in functions for atomic
   // memory access expect.
+
+  namespace __atomic_impl
+  {
+    template<typename _Tp>
+      using _Val = typename remove_volatile<_Tp>::type;
+
+#if __glibcxx_atomic_min_max
+    template<typename _Tp>
+      _Tp
+      __fetch_min(_Tp* __ptr, _Val<_Tp> __i, memory_order __m) noexcept;
+
+    template<typename _Tp>
+      _Tp
+      __fetch_max(_Tp* __ptr, _Val<_Tp> __i, memory_order __m) noexcept;
+#endif
+  }
+
   template<typename _ITp>
     struct __atomic_base
     {
@@ -674,6 +691,28 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
       fetch_xor(__int_type __i,
                memory_order __m = memory_order_seq_cst) volatile noexcept
       { return __atomic_fetch_xor(&_M_i, __i, int(__m)); }
+
+#if __glibcxx_atomic_min_max
+      _GLIBCXX_ALWAYS_INLINE __int_type
+      fetch_min(__int_type __i,
+               memory_order __m = memory_order_seq_cst) noexcept
+      { return __atomic_impl::__fetch_min(&_M_i, __i, __m); }
+
+      _GLIBCXX_ALWAYS_INLINE __int_type
+      fetch_min(__int_type __i,
+               memory_order __m = memory_order_seq_cst) volatile noexcept
+      { return __atomic_impl::__fetch_min(&_M_i, __i, __m); }
+
+      _GLIBCXX_ALWAYS_INLINE __int_type
+      fetch_max(__int_type __i,
+               memory_order __m = memory_order_seq_cst) noexcept
+      { return __atomic_impl::__fetch_max(&_M_i, __i, __m); }
+
+      _GLIBCXX_ALWAYS_INLINE __int_type
+      fetch_max(__int_type __i,
+               memory_order __m = memory_order_seq_cst) volatile noexcept
+      { return __atomic_impl::__fetch_max(&_M_i, __i, __m); }
+#endif
     };
 
 
@@ -976,10 +1015,6 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
        return __ptr;
       }
 
-    // Remove volatile and create a non-deduced context for value arguments.
-    template<typename _Tp>
-      using _Val = typename remove_volatile<_Tp>::type;
-
 #pragma GCC diagnostic push
 #pragma GCC diagnostic ignored "-Wc++17-extensions"
 
@@ -1293,6 +1328,49 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
            return __newval;
          }
       }
+
+#if __glibcxx_atomic_min_max
+    template<typename _Tp>
+      concept __atomic_fetch_minmaxable
+       = requires (_Tp __t) {
+           __atomic_fetch_min(&__t, __t, 0);
+           __atomic_fetch_max(&__t, __t, 0);
+         };
+
+    template<typename _Tp>
+      _Tp
+      __fetch_min(_Tp* __ptr, _Val<_Tp> __i, memory_order __m) noexcept
+      {
+       if constexpr (__atomic_fetch_minmaxable<_Tp>)
+         return __atomic_fetch_min(__ptr, __i, int(__m));
+       else
+         {
+           _Val<_Tp> __oldval = load (__ptr, memory_order_relaxed);
+           _Val<_Tp> __newval = __oldval < __i ? __oldval : __i;
+           while (!compare_exchange_weak (__ptr, __oldval, __newval, __m,
+                                          memory_order_relaxed))
+             __newval = __oldval < __i ? __oldval : __i;
+           return __oldval;
+         }
+      }
+
+    template<typename _Tp>
+      _Tp
+      __fetch_max(_Tp* __ptr, _Val<_Tp> __i, memory_order __m) noexcept
+      {
+       if constexpr (__atomic_fetch_minmaxable<_Tp>)
+         return __atomic_fetch_max(__ptr, __i, int(__m));
+       else
+         {
+           _Val<_Tp> __oldval = load (__ptr, memory_order_relaxed);
+           _Val<_Tp> __newval = __oldval > __i ? __oldval : __i;
+           while (!compare_exchange_weak (__ptr, __oldval, __newval, __m,
+                                          memory_order_relaxed))
+             __newval = __oldval > __i ? __oldval : __i;
+           return __oldval;
+         }
+      }
+#endif
   } // namespace __atomic_impl
 
   // base class for atomic<floating-point-type>
@@ -1487,6 +1565,28 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
                memory_order __m = memory_order_seq_cst) volatile noexcept
       { return __atomic_impl::__fetch_sub_flt(&_M_fp, __i, __m); }
 
+#if __glibcxx_atomic_min_max
+      value_type
+      fetch_min(value_type __i,
+               memory_order __m = memory_order_seq_cst) noexcept
+      { return __atomic_impl::__fetch_min(&_M_fp, __i, __m); }
+
+      value_type
+      fetch_min(value_type __i,
+               memory_order __m = memory_order_seq_cst) volatile noexcept
+      { return __atomic_impl::__fetch_min(&_M_fp, __i, __m); }
+
+      value_type
+      fetch_max(value_type __i,
+               memory_order __m = memory_order_seq_cst) noexcept
+      { return __atomic_impl::__fetch_max(&_M_fp, __i, __m); }
+
+      value_type
+      fetch_max(value_type __i,
+               memory_order __m = memory_order_seq_cst) volatile noexcept
+      { return __atomic_impl::__fetch_max(&_M_fp, __i, __m); }
+#endif
+
       value_type
       operator+=(value_type __i) noexcept
       { return __atomic_impl::__add_fetch_flt(&_M_fp, __i); }
@@ -1746,6 +1846,18 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
                memory_order __m = memory_order_seq_cst) const noexcept
       { return __atomic_impl::fetch_xor(this->_M_ptr, __i, __m); }
 
+#if __glibcxx_atomic_min_max
+      value_type
+      fetch_min(value_type __i,
+               memory_order __m = memory_order_seq_cst) const noexcept
+      { return __atomic_impl::__fetch_min(this->_M_ptr, __i, __m); }
+
+      value_type
+      fetch_max(value_type __i,
+               memory_order __m = memory_order_seq_cst) const noexcept
+      { return __atomic_impl::__fetch_max(this->_M_ptr, __i, __m); }
+#endif
+
       _GLIBCXX_ALWAYS_INLINE value_type
       operator++(int) const noexcept
       { return fetch_add(1); }
@@ -1812,6 +1924,18 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
                memory_order __m = memory_order_seq_cst) const noexcept
       { return __atomic_impl::__fetch_sub_flt(this->_M_ptr, __i, __m); }
 
+#if __glibcxx_atomic_min_max
+      value_type
+      fetch_min(value_type __i,
+               memory_order __m = memory_order_seq_cst) const noexcept
+      { return __atomic_impl::__fetch_min(this->_M_ptr, __i, __m); }
+
+      value_type
+      fetch_max(value_type __i,
+               memory_order __m = memory_order_seq_cst) const noexcept
+      { return __atomic_impl::__fetch_max(this->_M_ptr, __i, __m); }
+#endif
+
       value_type
       operator+=(value_type __i) const noexcept
       { return __atomic_impl::__add_fetch_flt(this->_M_ptr, __i); }

diff --git a/libstdc++-v3/include/bits/version.def b/libstdc++-v3/include/bits/version.def
index a1672b6be49ffe1dc886dc093290b03631cf26c1..8c5f4bb7c4c5fa66205a2926d7a70164fe112dc3 100644 (file)
--- a/libstdc++-v3/include/bits/version.def
+++ b/libstdc++-v3/include/bits/version.def
@@ -789,6 +789,14 @@ ftms = {
   };
 };
 
+ftms = {
+  name = atomic_min_max;
+  values = {
+    v = 202403;
+    cxxmin = 26;
+  };
+};
+
 ftms = {
   name = atomic_lock_free_type_aliases;
   values = {

diff --git a/libstdc++-v3/include/bits/version.h b/libstdc++-v3/include/bits/version.h
index dccc2a6c0df6f71d89d485e7655fac77ba2de870..985701447beedb2bd03840f6baa83b55e316b671 100644 (file)
--- a/libstdc++-v3/include/bits/version.h
+++ b/libstdc++-v3/include/bits/version.h
@@ -878,6 +878,16 @@
 #endif /* !defined(__cpp_lib_atomic_float) */
 #undef __glibcxx_want_atomic_float
 
+#if !defined(__cpp_lib_atomic_min_max)
+# if (__cplusplus >  202302L)
+#  define __glibcxx_atomic_min_max 202403L
+#  if defined(__glibcxx_want_all) || defined(__glibcxx_want_atomic_min_max)
+#   define __cpp_lib_atomic_min_max 202403L
+#  endif
+# endif
+#endif /* !defined(__cpp_lib_atomic_min_max) */
+#undef __glibcxx_want_atomic_min_max
+
 #if !defined(__cpp_lib_atomic_lock_free_type_aliases)
 # if (__cplusplus >= 202002L) && ((__GCC_ATOMIC_INT_LOCK_FREE | __GCC_ATOMIC_LONG_LOCK_FREE | __GCC_ATOMIC_CHAR_LOCK_FREE) & 2)
 #  define __glibcxx_atomic_lock_free_type_aliases 201907L

diff --git a/libstdc++-v3/include/std/atomic b/libstdc++-v3/include/std/atomic
index 62bc6b03f784f8c1c4201cb9176a9c80d67b6925..46d2bbb509efbce3fdfaee23fa36d9c539f5ca71 100644 (file)
--- a/libstdc++-v3/include/std/atomic
+++ b/libstdc++-v3/include/std/atomic
@@ -43,6 +43,7 @@
 #define __glibcxx_want_atomic_is_always_lock_free
 #define __glibcxx_want_atomic_flag_test
 #define __glibcxx_want_atomic_float
+#define __glibcxx_want_atomic_min_max
 #define __glibcxx_want_atomic_ref
 #define __glibcxx_want_atomic_lock_free_type_aliases
 #define __glibcxx_want_atomic_value_initialization
@@ -1568,6 +1569,36 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
                              memory_order __m) noexcept
     { return __a->fetch_xor(__i, __m); }
 
+#ifdef __cpp_lib_atomic_min_max
+  template<typename _ITp>
+    inline _ITp
+    atomic_fetch_min_explicit(__atomic_base<_ITp>* __a,
+                             __atomic_val_t<_ITp> __i,
+                             memory_order __m) noexcept
+    { return __a->fetch_min(__i, __m); }
+
+  template<typename _ITp>
+    inline _ITp
+    atomic_fetch_min_explicit(volatile __atomic_base<_ITp>* __a,
+                             __atomic_val_t<_ITp> __i,
+                             memory_order __m) noexcept
+    { return __a->fetch_min(__i, __m); }
+
+  template<typename _ITp>
+    inline _ITp
+    atomic_fetch_max_explicit(__atomic_base<_ITp>* __a,
+                             __atomic_val_t<_ITp> __i,
+                             memory_order __m) noexcept
+    { return __a->fetch_max(__i, __m); }
+
+  template<typename _ITp>
+    inline _ITp
+    atomic_fetch_max_explicit(volatile __atomic_base<_ITp>* __a,
+                             __atomic_val_t<_ITp> __i,
+                             memory_order __m) noexcept
+    { return __a->fetch_max(__i, __m); }
+#endif
+
   template<typename _ITp>
     inline _ITp
     atomic_fetch_add(atomic<_ITp>* __a,
@@ -1628,6 +1659,32 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
                     __atomic_val_t<_ITp> __i) noexcept
     { return atomic_fetch_xor_explicit(__a, __i, memory_order_seq_cst); }
 
+#ifdef __cpp_lib_atomic_min_max
+  template<typename _ITp>
+    inline _ITp
+    atomic_fetch_min(__atomic_base<_ITp>* __a,
+                    __atomic_val_t<_ITp> __i) noexcept
+    { return atomic_fetch_min_explicit(__a, __i, memory_order_seq_cst); }
+
+  template<typename _ITp>
+    inline _ITp
+    atomic_fetch_min(volatile __atomic_base<_ITp>* __a,
+                    __atomic_val_t<_ITp> __i) noexcept
+    { return atomic_fetch_min_explicit(__a, __i, memory_order_seq_cst); }
+
+  template<typename _ITp>
+    inline _ITp
+    atomic_fetch_max(__atomic_base<_ITp>* __a,
+                    __atomic_val_t<_ITp> __i) noexcept
+    { return atomic_fetch_max_explicit(__a, __i, memory_order_seq_cst); }
+
+  template<typename _ITp>
+    inline _ITp
+    atomic_fetch_max(volatile __atomic_base<_ITp>* __a,
+                    __atomic_val_t<_ITp> __i) noexcept
+    { return atomic_fetch_max_explicit(__a, __i, memory_order_seq_cst); }
+#endif
+
 #ifdef __cpp_lib_atomic_float
   template<>
     struct atomic<float> : __atomic_float<float>

diff --git a/libstdc++-v3/src/c++23/std.cc.in b/libstdc++-v3/src/c++23/std.cc.in
index f38660498ccfd2cfc9272377f3e5a2defc60d3ab..424f81004d6113e51c59c7bd48d8e5c0bbf1f021 100644 (file)
--- a/libstdc++-v3/src/c++23/std.cc.in
+++ b/libstdc++-v3/src/c++23/std.cc.in
@@ -570,6 +570,12 @@ export namespace std
   using std::atomic_fetch_sub_explicit;
   using std::atomic_fetch_xor;
   using std::atomic_fetch_xor_explicit;
+#ifdef __cpp_lib_atomic_min_max
+  using std::atomic_fetch_min;
+  using std::atomic_fetch_min_explicit;
+  using std::atomic_fetch_max;
+  using std::atomic_fetch_max_explicit;
+#endif
   using std::atomic_flag;
   using std::atomic_flag_clear;
   using std::atomic_flag_clear_explicit;

diff --git a/libstdc++-v3/testsuite/29_atomics/atomic_integral/nonmembers_fetch_minmax.cc b/libstdc++-v3/testsuite/29_atomics/atomic_integral/nonmembers_fetch_minmax.cc
new file mode 100644 (file)
index 0000000..6d6c83c
--- /dev/null
+++ b/libstdc++-v3/testsuite/29_atomics/atomic_integral/nonmembers_fetch_minmax.cc
@@ -0,0 +1,50 @@
+// { dg-do compile { target c++26 } }
+// { dg-require-atomic-builtins "" }
+
+#include <atomic>
+
+void
+test01()
+{
+  volatile std::atomic<int> v;
+  std::atomic<long> a;
+  const std::memory_order mo = std::memory_order_seq_cst;
+  int i = 0;
+  long l = 0;
+
+  auto r1 = atomic_fetch_min(&v, i);
+  static_assert( std::is_same<decltype(r1), int>::value, "" );
+  auto r2 = atomic_fetch_min(&a, l);
+  static_assert( std::is_same<decltype(r2), long>::value, "" );
+  auto r3 = atomic_fetch_min_explicit(&v, i, mo);
+  static_assert( std::is_same<decltype(r3), int>::value, "" );
+  auto r4 = atomic_fetch_min_explicit(&a, l, mo);
+  static_assert( std::is_same<decltype(r4), long>::value, "" );
+
+  auto r5 = atomic_fetch_max(&v, i);
+  static_assert( std::is_same<decltype(r5), int>::value, "" );
+  auto r6 = atomic_fetch_max(&a, l);
+  static_assert( std::is_same<decltype(r6), long>::value, "" );
+  auto r7 = atomic_fetch_max_explicit(&v, i, mo);
+  static_assert( std::is_same<decltype(r7), int>::value, "" );
+  auto r8 = atomic_fetch_max_explicit(&a, l, mo);
+  static_assert( std::is_same<decltype(r8), long>::value, "" );
+}
+
+void
+test02()
+{
+  volatile std::atomic<long> v;
+  std::atomic<long> a;
+  std::memory_order mo = std::memory_order_seq_cst;
+  const int i = 0;
+
+  atomic_fetch_min(&v, i);
+  atomic_fetch_min(&a, i);
+  atomic_fetch_min_explicit(&v, i, mo);
+  atomic_fetch_min_explicit(&a, i, mo);
+  atomic_fetch_max(&v, i);
+  atomic_fetch_max(&a, i);
+  atomic_fetch_max_explicit(&v, i, mo);
+  atomic_fetch_max_explicit(&a, i, mo);
+}

diff --git a/libstdc++-v3/testsuite/29_atomics/atomic_ref/integral_fetch_minmax.cc b/libstdc++-v3/testsuite/29_atomics/atomic_ref/integral_fetch_minmax.cc
new file mode 100644 (file)
index 0000000..9d7fa68
--- /dev/null
+++ b/libstdc++-v3/testsuite/29_atomics/atomic_ref/integral_fetch_minmax.cc
@@ -0,0 +1,118 @@
+// { dg-do run { target c++26 } }
+// { dg-require-atomic-cmpxchg-word "" }
+// { dg-add-options libatomic }
+
+#include <atomic>
+#include <limits.h>
+#include <testsuite_hooks.h>
+
+void
+test01()
+{
+  int value;
+  const auto mo = std::memory_order_relaxed;
+
+  {
+    std::atomic_ref<int> a(value);
+
+    a = 100;
+    auto v = a.fetch_min(50);
+    VERIFY( v == 100 );
+    VERIFY( a == 50 );
+
+    v = a.fetch_min(75, mo);
+    VERIFY( v == 50 );
+    VERIFY( a == 50 );
+
+    v = a.fetch_min(25);
+    VERIFY( v == 50 );
+    VERIFY( a == 25 );
+
+    a = -10;
+    v = a.fetch_min(-20);
+    VERIFY( v == -10 );
+    VERIFY( a == -20 );
+
+    v = a.fetch_min(-5, mo);
+    VERIFY( v == -20 );
+    VERIFY( a == -20 );
+
+    a = 20;
+    v = a.fetch_max(50);
+    VERIFY( v == 20 );
+    VERIFY( a == 50 );
+
+    v = a.fetch_max(30, mo);
+    VERIFY( v == 50 );
+    VERIFY( a == 50 );
+
+    v = a.fetch_max(100);
+    VERIFY( v == 50 );
+    VERIFY( a == 100 );
+
+    a = -50;
+    v = a.fetch_max(-20);
+    VERIFY( v == -50 );
+    VERIFY( a == -20 );
+
+    v = a.fetch_max(-30, mo);
+    VERIFY( v == -20 );
+    VERIFY( a == -20 );
+  }
+
+  VERIFY( value == -20 );
+}
+
+void
+test02()
+{
+  unsigned short value;
+  const auto mo = std::memory_order_relaxed;
+
+  {
+    std::atomic_ref<unsigned short> a(value);
+
+    a = 100;
+    auto v = a.fetch_min(50);
+    VERIFY( v == 100 );
+    VERIFY( a == 50 );
+
+    v = a.fetch_min(75, mo);
+    VERIFY( v == 50 );
+    VERIFY( a == 50 );
+
+    a = 20;
+    v = a.fetch_max(50);
+    VERIFY( v == 20 );
+    VERIFY( a == 50 );
+
+    v = a.fetch_max(30, mo);
+    VERIFY( v == 50 );
+    VERIFY( a == 50 );
+
+    v = a.fetch_max(200);
+    VERIFY( v == 50 );
+    VERIFY( a == 200 );
+  }
+
+  VERIFY( value == 200 );
+}
+
+void
+test03()
+{
+  int i = INT_MIN;
+  std::atomic_ref<int> a(i);
+  a.fetch_min(INT_MAX);
+  VERIFY( a == INT_MIN );
+  a.fetch_max(INT_MAX);
+  VERIFY( a == INT_MAX );
+}
+
+int
+main()
+{
+  test01();
+  test02();
+  test03();
+}