libcxx/include/semaphore

   1 // -*- C++ -*-
   2 //===----------------------------------------------------------------------===//
   3 //
   4 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   5 // See https://llvm.org/LICENSE.txt for license information.
   6 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #ifndef _LIBCPP_SEMAPHORE
  11 #define _LIBCPP_SEMAPHORE
  12
  13 /*
  14     semaphore synopsis
  15
  16 namespace std {
  17
  18 template<ptrdiff_t least_max_value = implementation-defined>
  19 class counting_semaphore                          // since C++20
  20 {
  21 public:
  22 static constexpr ptrdiff_t max() noexcept;
  23
  24 constexpr explicit counting_semaphore(ptrdiff_t desired);
  25 ~counting_semaphore();
  26
  27 counting_semaphore(const counting_semaphore&) = delete;
  28 counting_semaphore& operator=(const counting_semaphore&) = delete;
  29
  30 void release(ptrdiff_t update = 1);
  31 void acquire();
  32 bool try_acquire() noexcept;
  33 template<class Rep, class Period>
  34     bool try_acquire_for(const chrono::duration<Rep, Period>& rel_time);
  35 template<class Clock, class Duration>
  36     bool try_acquire_until(const chrono::time_point<Clock, Duration>& abs_time);
  37
  38 private:
  39 ptrdiff_t counter; // exposition only
  40 };
  41
  42 using binary_semaphore = counting_semaphore<1>; // since C++20
  43
  44 }
  45
  46 */
  47
  48 #if __cplusplus < 201103L && defined(_LIBCPP_USE_FROZEN_CXX03_HEADERS)
  49 #  include <__cxx03/semaphore>
  50 #else
  51 #  include <__config>
  52
  53 #  if _LIBCPP_HAS_THREADS
  54
  55 #    include <__assert>
  56 #    include <__atomic/atomic.h>
  57 #    include <__atomic/atomic_sync.h>
  58 #    include <__atomic/memory_order.h>
  59 #    include <__chrono/time_point.h>
  60 #    include <__cstddef/ptrdiff_t.h>
  61 #    include <__thread/poll_with_backoff.h>
  62 #    include <__thread/support.h>
  63 #    include <__thread/timed_backoff_policy.h>
  64 #    include <limits>
  65 #    include <version>
  66
  67 #    if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
  68 #      pragma GCC system_header
  69 #    endif
  70
  71 _LIBCPP_PUSH_MACROS
  72 #    include <__undef_macros>
  73
  74 #    if _LIBCPP_STD_VER >= 20
  75
  76 _LIBCPP_BEGIN_NAMESPACE_STD
  77
  78 /*
  79
  80 __atomic_semaphore_base is the general-case implementation.
  81 It is a typical Dijkstra semaphore algorithm over atomics, wait and notify
  82 functions. It avoids contention against users' own use of those facilities.
  83
  84 */
  85
  86 #      define _LIBCPP_SEMAPHORE_MAX (numeric_limits<ptrdiff_t>::max())
  87
  88 class __atomic_semaphore_base {
  89   atomic<ptrdiff_t> __a_;
  90
  91 public:
  92   _LIBCPP_HIDE_FROM_ABI constexpr explicit __atomic_semaphore_base(ptrdiff_t __count) : __a_(__count) {}
  93   _LIBCPP_AVAILABILITY_SYNC _LIBCPP_HIDE_FROM_ABI void release(ptrdiff_t __update = 1) {
  94     auto __old = __a_.fetch_add(__update, memory_order_release);
  95     _LIBCPP_ASSERT_ARGUMENT_WITHIN_DOMAIN(
  96         __update <= _LIBCPP_SEMAPHORE_MAX - __old, "update is greater than the expected value");
  97     if (__old == 0) {
  98       __a_.notify_all();
  99     }
 100   }
 101   _LIBCPP_AVAILABILITY_SYNC _LIBCPP_HIDE_FROM_ABI void acquire() {
 102     std::__atomic_wait_unless(__a_, memory_order_relaxed, [this](ptrdiff_t& __old) {
 103       return __try_acquire_impl(__old);
 104     });
 105   }
 106   template <class _Rep, class _Period>
 107   _LIBCPP_AVAILABILITY_SYNC _LIBCPP_HIDE_FROM_ABI bool
 108   try_acquire_for(chrono::duration<_Rep, _Period> const& __rel_time) {
 109     if (__rel_time == chrono::duration<_Rep, _Period>::zero())
 110       return try_acquire();
 111     auto const __poll_fn = [this]() { return try_acquire(); };
 112     return std::__libcpp_thread_poll_with_backoff(__poll_fn, __libcpp_timed_backoff_policy(), __rel_time);
 113   }
 114   _LIBCPP_AVAILABILITY_SYNC _LIBCPP_HIDE_FROM_ABI bool try_acquire() {
 115     auto __old = __a_.load(memory_order_relaxed);
 116     return __try_acquire_impl(__old);
 117   }
 118
 119 private:
 120   _LIBCPP_AVAILABILITY_SYNC _LIBCPP_HIDE_FROM_ABI bool __try_acquire_impl(ptrdiff_t& __old) {
 121     while (true) {
 122       if (__old == 0)
 123         return false;
 124       if (__a_.compare_exchange_weak(__old, __old - 1, memory_order_acquire, memory_order_relaxed))
 125         return true;
 126     }
 127   }
 128 };
 129
 130 template <ptrdiff_t __least_max_value = _LIBCPP_SEMAPHORE_MAX>
 131 class counting_semaphore {
 132   __atomic_semaphore_base __semaphore_;
 133
 134 public:
 135   static_assert(__least_max_value >= 0, "The least maximum value must be a positive number");
 136
 137   static constexpr ptrdiff_t max() noexcept { return __least_max_value; }
 138
 139   _LIBCPP_HIDE_FROM_ABI constexpr explicit counting_semaphore(ptrdiff_t __count) : __semaphore_(__count) {
 140     _LIBCPP_ASSERT_ARGUMENT_WITHIN_DOMAIN(
 141         __count >= 0,
 142         "counting_semaphore::counting_semaphore(ptrdiff_t): counting_semaphore cannot be "
 143         "initialized with a negative value");
 144     _LIBCPP_ASSERT_ARGUMENT_WITHIN_DOMAIN(
 145         __count <= max(),
 146         "counting_semaphore::counting_semaphore(ptrdiff_t): counting_semaphore cannot be "
 147         "initialized with a value greater than max()");
 148   }
 149   ~counting_semaphore() = default;
 150
 151   counting_semaphore(const counting_semaphore&)            = delete;
 152   counting_semaphore& operator=(const counting_semaphore&) = delete;
 153
 154   _LIBCPP_AVAILABILITY_SYNC _LIBCPP_HIDE_FROM_ABI void release(ptrdiff_t __update = 1) {
 155     _LIBCPP_ASSERT_ARGUMENT_WITHIN_DOMAIN(__update >= 0, "counting_semaphore:release called with a negative value");
 156     __semaphore_.release(__update);
 157   }
 158   _LIBCPP_AVAILABILITY_SYNC _LIBCPP_HIDE_FROM_ABI void acquire() { __semaphore_.acquire(); }
 159   template <class _Rep, class _Period>
 160   _LIBCPP_AVAILABILITY_SYNC _LIBCPP_HIDE_FROM_ABI bool
 161   try_acquire_for(chrono::duration<_Rep, _Period> const& __rel_time) {
 162     return __semaphore_.try_acquire_for(chrono::duration_cast<chrono::nanoseconds>(__rel_time));
 163   }
 164   _LIBCPP_AVAILABILITY_SYNC _LIBCPP_HIDE_FROM_ABI bool try_acquire() { return __semaphore_.try_acquire(); }
 165   template <class _Clock, class _Duration>
 166   _LIBCPP_AVAILABILITY_SYNC _LIBCPP_HIDE_FROM_ABI bool
 167   try_acquire_until(chrono::time_point<_Clock, _Duration> const& __abs_time) {
 168     auto const __current = _Clock::now();
 169     if (__current >= __abs_time)
 170       return try_acquire();
 171     else
 172       return try_acquire_for(__abs_time - __current);
 173   }
 174 };
 175
 176 using binary_semaphore = counting_semaphore<1>;
 177
 178 _LIBCPP_END_NAMESPACE_STD
 179
 180 #    endif // _LIBCPP_STD_VER >= 20
 181
 182 _LIBCPP_POP_MACROS
 183
 184 #  endif // _LIBCPP_HAS_THREADS
 185
 186 #  if !defined(_LIBCPP_REMOVE_TRANSITIVE_INCLUDES) && _LIBCPP_STD_VER <= 20
 187 #    include <atomic>
 188 #    include <cstddef>
 189 #  endif
 190 #endif // __cplusplus < 201103L && defined(_LIBCPP_USE_FROZEN_CXX03_HEADERS)
 191
 192 #endif // _LIBCPP_SEMAPHORE