1 // <future> -*- C++ -*-
3 // Copyright (C) 2009-2022 Free Software Foundation, Inc.
5 // This file is part of the GNU ISO C++ Library. This library is free
6 // software; you can redistribute it and/or modify it under the
7 // terms of the GNU General Public License as published by the
8 // Free Software Foundation; either version 3, or (at your option)
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // Under Section 7 of GPL version 3, you are granted additional
17 // permissions described in the GCC Runtime Library Exception, version
18 // 3.1, as published by the Free Software Foundation.
20 // You should have received a copy of the GNU General Public License and
21 // a copy of the GCC Runtime Library Exception along with this program;
22 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23 // <http://www.gnu.org/licenses/>.
25 /** @file include/future
26 * This is a Standard C++ Library header.
29 #ifndef _GLIBCXX_FUTURE
30 #define _GLIBCXX_FUTURE 1
32 #pragma GCC system_header
34 #if __cplusplus < 201103L
35 # include <bits/c++0x_warning.h>
38 #include <mutex> // call_once
39 #include <condition_variable> // __at_thread_exit_elt
40 #include <system_error>
41 #include <bits/atomic_base.h> // atomic_flag
42 #include <bits/allocated_ptr.h>
43 #include <bits/atomic_futex.h>
44 #include <bits/exception_defines.h>
45 #include <bits/invoke.h>
46 #include <bits/unique_ptr.h>
47 #include <bits/shared_ptr.h>
48 #include <bits/std_function.h>
49 #include <bits/std_thread.h>
50 #include <bits/uses_allocator.h>
51 #include <ext/aligned_buffer.h>
53 namespace std _GLIBCXX_VISIBILITY(default)
55 _GLIBCXX_BEGIN_NAMESPACE_VERSION
58 * @defgroup futures Futures
59 * @ingroup concurrency
61 * Classes for futures support.
65 /// Error code for futures
66 enum class future_errc
68 future_already_retrieved = 1,
69 promise_already_satisfied,
76 struct is_error_code_enum<future_errc> : public true_type { };
78 /// Points to a statically-allocated object derived from error_category.
80 future_category() noexcept;
82 /// Overload for make_error_code.
84 make_error_code(future_errc __errc) noexcept
85 { return error_code(static_cast<int>(__errc), future_category()); }
87 /// Overload for make_error_condition.
88 inline error_condition
89 make_error_condition(future_errc __errc) noexcept
90 { return error_condition(static_cast<int>(__errc), future_category()); }
93 * @brief Exception type thrown by futures.
96 class future_error : public logic_error
100 future_error(future_errc __errc)
101 : future_error(std::make_error_code(__errc))
104 virtual ~future_error() noexcept;
107 what() const noexcept;
110 code() const noexcept { return _M_code; }
114 future_error(error_code __ec)
115 : logic_error("std::future_error: " + __ec.message()), _M_code(__ec)
118 friend void __throw_future_error(int);
123 // Forward declarations.
124 template<typename _Res>
127 template<typename _Res>
130 template<typename _Signature>
133 template<typename _Res>
136 /// Launch code for futures
143 constexpr launch operator&(launch __x, launch __y) noexcept
145 return static_cast<launch>(
146 static_cast<int>(__x) & static_cast<int>(__y));
149 constexpr launch operator|(launch __x, launch __y) noexcept
151 return static_cast<launch>(
152 static_cast<int>(__x) | static_cast<int>(__y));
155 constexpr launch operator^(launch __x, launch __y) noexcept
157 return static_cast<launch>(
158 static_cast<int>(__x) ^ static_cast<int>(__y));
161 constexpr launch operator~(launch __x) noexcept
162 { return static_cast<launch>(~static_cast<int>(__x)); }
164 inline launch& operator&=(launch& __x, launch __y) noexcept
165 { return __x = __x & __y; }
167 inline launch& operator|=(launch& __x, launch __y) noexcept
168 { return __x = __x | __y; }
170 inline launch& operator^=(launch& __x, launch __y) noexcept
171 { return __x = __x ^ __y; }
173 /// Status code for futures
174 enum class future_status
181 // _GLIBCXX_RESOLVE_LIB_DEFECTS
182 // 2021. Further incorrect usages of result_of
183 template<typename _Fn, typename... _Args>
184 using __async_result_of = typename __invoke_result<
185 typename decay<_Fn>::type, typename decay<_Args>::type...>::type;
187 template<typename _Fn, typename... _Args>
188 future<__async_result_of<_Fn, _Args...>>
189 async(launch __policy, _Fn&& __fn, _Args&&... __args);
191 template<typename _Fn, typename... _Args>
192 future<__async_result_of<_Fn, _Args...>>
193 async(_Fn&& __fn, _Args&&... __args);
195 #if defined(_GLIBCXX_HAS_GTHREADS)
197 /// Base class and enclosing scope.
200 /// Base class for results.
203 exception_ptr _M_error;
205 _Result_base(const _Result_base&) = delete;
206 _Result_base& operator=(const _Result_base&) = delete;
208 // _M_destroy() allows derived classes to control deallocation
209 virtual void _M_destroy() = 0;
213 void operator()(_Result_base* __fr) const { __fr->_M_destroy(); }
218 virtual ~_Result_base();
221 /// A unique_ptr for result objects.
222 template<typename _Res>
223 using _Ptr = unique_ptr<_Res, _Result_base::_Deleter>;
225 /// A result object that has storage for an object of type _Res.
226 template<typename _Res>
227 struct _Result : _Result_base
230 __gnu_cxx::__aligned_buffer<_Res> _M_storage;
234 typedef _Res result_type;
236 _Result() noexcept : _M_initialized() { }
244 // Return lvalue, future will add const or rvalue-reference
246 _M_value() noexcept { return *_M_storage._M_ptr(); }
249 _M_set(const _Res& __res)
251 ::new (_M_storage._M_addr()) _Res(__res);
252 _M_initialized = true;
258 ::new (_M_storage._M_addr()) _Res(std::move(__res));
259 _M_initialized = true;
263 void _M_destroy() { delete this; }
266 /// A result object that uses an allocator.
267 template<typename _Res, typename _Alloc>
268 struct _Result_alloc final : _Result<_Res>, _Alloc
270 using __allocator_type = __alloc_rebind<_Alloc, _Result_alloc>;
273 _Result_alloc(const _Alloc& __a) : _Result<_Res>(), _Alloc(__a)
279 __allocator_type __a(*this);
280 __allocated_ptr<__allocator_type> __guard_ptr{ __a, this };
281 this->~_Result_alloc();
285 // Create a result object that uses an allocator.
286 template<typename _Res, typename _Allocator>
287 static _Ptr<_Result_alloc<_Res, _Allocator>>
288 _S_allocate_result(const _Allocator& __a)
290 using __result_type = _Result_alloc<_Res, _Allocator>;
291 typename __result_type::__allocator_type __a2(__a);
292 auto __guard = std::__allocate_guarded(__a2);
293 __result_type* __p = ::new((void*)__guard.get()) __result_type{__a};
295 return _Ptr<__result_type>(__p);
298 // Keep it simple for std::allocator.
299 template<typename _Res, typename _Tp>
300 static _Ptr<_Result<_Res>>
301 _S_allocate_result(const std::allocator<_Tp>& __a)
303 return _Ptr<_Result<_Res>>(new _Result<_Res>);
306 // Base class for various types of shared state created by an
307 // asynchronous provider (such as a std::promise) and shared with one
308 // or more associated futures.
311 typedef _Ptr<_Result_base> _Ptr_type;
313 enum _Status : unsigned {
319 __atomic_futex_unsigned<> _M_status;
320 atomic_flag _M_retrieved = ATOMIC_FLAG_INIT;
324 _State_baseV2() noexcept : _M_result(), _M_status(_Status::__not_ready)
326 _State_baseV2(const _State_baseV2&) = delete;
327 _State_baseV2& operator=(const _State_baseV2&) = delete;
328 virtual ~_State_baseV2() = default;
333 // Run any deferred function or join any asynchronous thread:
335 // Acquire MO makes sure this synchronizes with the thread that made
337 _M_status._M_load_when_equal(_Status::__ready, memory_order_acquire);
341 template<typename _Rep, typename _Period>
343 wait_for(const chrono::duration<_Rep, _Period>& __rel)
345 // First, check if the future has been made ready. Use acquire MO
346 // to synchronize with the thread that made it ready.
347 if (_M_status._M_load(memory_order_acquire) == _Status::__ready)
348 return future_status::ready;
350 if (_M_is_deferred_future())
351 return future_status::deferred;
353 // Don't wait unless the relative time is greater than zero.
354 if (__rel > __rel.zero()
355 && _M_status._M_load_when_equal_for(_Status::__ready,
356 memory_order_acquire,
359 // _GLIBCXX_RESOLVE_LIB_DEFECTS
360 // 2100. timed waiting functions must also join
361 // This call is a no-op by default except on an async future,
362 // in which case the async thread is joined. It's also not a
363 // no-op for a deferred future, but such a future will never
364 // reach this point because it returns future_status::deferred
365 // instead of waiting for the future to become ready (see
366 // above). Async futures synchronize in this call, so we need
367 // no further synchronization here.
370 return future_status::ready;
372 return future_status::timeout;
375 template<typename _Clock, typename _Duration>
377 wait_until(const chrono::time_point<_Clock, _Duration>& __abs)
379 #if __cplusplus > 201703L
380 static_assert(chrono::is_clock_v<_Clock>);
382 // First, check if the future has been made ready. Use acquire MO
383 // to synchronize with the thread that made it ready.
384 if (_M_status._M_load(memory_order_acquire) == _Status::__ready)
385 return future_status::ready;
387 if (_M_is_deferred_future())
388 return future_status::deferred;
390 if (_M_status._M_load_when_equal_until(_Status::__ready,
391 memory_order_acquire,
394 // _GLIBCXX_RESOLVE_LIB_DEFECTS
395 // 2100. timed waiting functions must also join
396 // See wait_for(...) above.
399 return future_status::ready;
401 return future_status::timeout;
404 // Provide a result to the shared state and make it ready.
405 // Calls at most once: _M_result = __res();
407 _M_set_result(function<_Ptr_type()> __res, bool __ignore_failure = false)
409 bool __did_set = false;
410 // all calls to this function are serialized,
411 // side-effects of invoking __res only happen once
412 call_once(_M_once, &_State_baseV2::_M_do_set, this,
413 std::__addressof(__res), std::__addressof(__did_set));
415 // Use release MO to synchronize with observers of the ready state.
416 _M_status._M_store_notify_all(_Status::__ready,
417 memory_order_release);
418 else if (!__ignore_failure)
419 __throw_future_error(int(future_errc::promise_already_satisfied));
422 // Provide a result to the shared state but delay making it ready
423 // until the calling thread exits.
424 // Calls at most once: _M_result = __res();
426 _M_set_delayed_result(function<_Ptr_type()> __res,
427 weak_ptr<_State_baseV2> __self)
429 bool __did_set = false;
430 unique_ptr<_Make_ready> __mr{new _Make_ready};
431 // all calls to this function are serialized,
432 // side-effects of invoking __res only happen once
433 call_once(_M_once, &_State_baseV2::_M_do_set, this,
434 std::__addressof(__res), std::__addressof(__did_set));
436 __throw_future_error(int(future_errc::promise_already_satisfied));
437 __mr->_M_shared_state = std::move(__self);
442 // Abandon this shared state.
444 _M_break_promise(_Ptr_type __res)
446 if (static_cast<bool>(__res))
449 make_exception_ptr(future_error(future_errc::broken_promise));
450 // This function is only called when the last asynchronous result
451 // provider is abandoning this shared state, so noone can be
452 // trying to make the shared state ready at the same time, and
453 // we can access _M_result directly instead of through call_once.
454 _M_result.swap(__res);
455 // Use release MO to synchronize with observers of the ready state.
456 _M_status._M_store_notify_all(_Status::__ready,
457 memory_order_release);
461 // Called when this object is first passed to a future.
463 _M_set_retrieved_flag()
465 if (_M_retrieved.test_and_set())
466 __throw_future_error(int(future_errc::future_already_retrieved));
469 template<typename _Res, typename _Arg>
473 template<typename _Res, typename _Arg>
474 struct _Setter<_Res, _Arg&>
476 // check this is only used by promise<R>::set_value(const R&)
477 // or promise<R&>::set_value(R&)
478 static_assert(is_same<_Res, _Arg&>::value // promise<R&>
479 || is_same<const _Res, _Arg>::value, // promise<R>
480 "Invalid specialisation");
482 // Used by std::promise to copy construct the result.
483 typename promise<_Res>::_Ptr_type operator()() const
485 _M_promise->_M_storage->_M_set(*_M_arg);
486 return std::move(_M_promise->_M_storage);
488 promise<_Res>* _M_promise;
493 template<typename _Res>
494 struct _Setter<_Res, _Res&&>
496 // Used by std::promise to move construct the result.
497 typename promise<_Res>::_Ptr_type operator()() const
499 _M_promise->_M_storage->_M_set(std::move(*_M_arg));
500 return std::move(_M_promise->_M_storage);
502 promise<_Res>* _M_promise;
507 template<typename _Res>
508 struct _Setter<_Res, void>
510 static_assert(is_void<_Res>::value, "Only used for promise<void>");
512 typename promise<_Res>::_Ptr_type operator()() const
513 { return std::move(_M_promise->_M_storage); }
515 promise<_Res>* _M_promise;
518 struct __exception_ptr_tag { };
521 template<typename _Res>
522 struct _Setter<_Res, __exception_ptr_tag>
524 // Used by std::promise to store an exception as the result.
525 typename promise<_Res>::_Ptr_type operator()() const
527 _M_promise->_M_storage->_M_error = *_M_ex;
528 return std::move(_M_promise->_M_storage);
531 promise<_Res>* _M_promise;
532 exception_ptr* _M_ex;
535 template<typename _Res, typename _Arg>
536 __attribute__((__always_inline__))
537 static _Setter<_Res, _Arg&&>
538 __setter(promise<_Res>* __prom, _Arg&& __arg) noexcept
540 return _Setter<_Res, _Arg&&>{ __prom, std::__addressof(__arg) };
543 template<typename _Res>
544 __attribute__((__always_inline__))
545 static _Setter<_Res, __exception_ptr_tag>
546 __setter(exception_ptr& __ex, promise<_Res>* __prom) noexcept
548 return _Setter<_Res, __exception_ptr_tag>{ __prom, &__ex };
551 template<typename _Res>
552 __attribute__((__always_inline__))
553 static _Setter<_Res, void>
554 __setter(promise<_Res>* __prom) noexcept
556 return _Setter<_Res, void>{ __prom };
559 template<typename _Tp>
561 _S_check(const shared_ptr<_Tp>& __p)
563 if (!static_cast<bool>(__p))
564 __throw_future_error((int)future_errc::no_state);
568 // The function invoked with std::call_once(_M_once, ...).
570 _M_do_set(function<_Ptr_type()>* __f, bool* __did_set)
572 _Ptr_type __res = (*__f)();
573 // Notify the caller that we did try to set; if we do not throw an
574 // exception, the caller will be aware that it did set (e.g., see
577 _M_result.swap(__res); // nothrow
580 // Wait for completion of async function.
581 virtual void _M_complete_async() { }
583 // Return true if state corresponds to a deferred function.
584 virtual bool _M_is_deferred_future() const { return false; }
586 struct _Make_ready final : __at_thread_exit_elt
588 weak_ptr<_State_baseV2> _M_shared_state;
589 static void _S_run(void*);
594 #ifdef _GLIBCXX_ASYNC_ABI_COMPAT
596 class _Async_state_common;
598 using _State_base = _State_baseV2;
599 class _Async_state_commonV2;
602 template<typename _BoundFn,
603 typename _Res = decltype(std::declval<_BoundFn&>()())>
604 class _Deferred_state;
606 template<typename _BoundFn,
607 typename _Res = decltype(std::declval<_BoundFn&>()())>
608 class _Async_state_impl;
610 template<typename _Signature>
611 class _Task_state_base;
613 template<typename _Fn, typename _Alloc, typename _Signature>
616 template<typename _Res_ptr, typename _Fn,
617 typename _Res = typename _Res_ptr::element_type::result_type>
620 template<typename _Res_ptr, typename _BoundFn>
621 static _Task_setter<_Res_ptr, _BoundFn>
622 _S_task_setter(_Res_ptr& __ptr, _BoundFn& __call)
624 return { std::__addressof(__ptr), std::__addressof(__call) };
628 /// Partial specialization for reference types.
629 template<typename _Res>
630 struct __future_base::_Result<_Res&> : __future_base::_Result_base
632 typedef _Res& result_type;
634 _Result() noexcept : _M_value_ptr() { }
637 _M_set(_Res& __res) noexcept
638 { _M_value_ptr = std::addressof(__res); }
640 _Res& _M_get() noexcept { return *_M_value_ptr; }
645 void _M_destroy() { delete this; }
648 /// Explicit specialization for void.
650 struct __future_base::_Result<void> : __future_base::_Result_base
652 typedef void result_type;
655 void _M_destroy() { delete this; }
658 #ifndef _GLIBCXX_ASYNC_ABI_COMPAT
660 // Allow _Setter objects to be stored locally in std::function
661 template<typename _Res, typename _Arg>
662 struct __is_location_invariant
663 <__future_base::_State_base::_Setter<_Res, _Arg>>
666 // Allow _Task_setter objects to be stored locally in std::function
667 template<typename _Res_ptr, typename _Fn, typename _Res>
668 struct __is_location_invariant
669 <__future_base::_Task_setter<_Res_ptr, _Fn, _Res>>
672 /// Common implementation for future and shared_future.
673 template<typename _Res>
674 class __basic_future : public __future_base
677 typedef shared_ptr<_State_base> __state_type;
678 typedef __future_base::_Result<_Res>& __result_type;
681 __state_type _M_state;
685 __basic_future(const __basic_future&) = delete;
686 __basic_future& operator=(const __basic_future&) = delete;
689 valid() const noexcept { return static_cast<bool>(_M_state); }
694 _State_base::_S_check(_M_state);
698 template<typename _Rep, typename _Period>
700 wait_for(const chrono::duration<_Rep, _Period>& __rel) const
702 _State_base::_S_check(_M_state);
703 return _M_state->wait_for(__rel);
706 template<typename _Clock, typename _Duration>
708 wait_until(const chrono::time_point<_Clock, _Duration>& __abs) const
710 _State_base::_S_check(_M_state);
711 return _M_state->wait_until(__abs);
715 /// Wait for the state to be ready and rethrow any stored exception
717 _M_get_result() const
719 _State_base::_S_check(_M_state);
720 _Result_base& __res = _M_state->wait();
721 if (!(__res._M_error == nullptr))
722 rethrow_exception(__res._M_error);
723 return static_cast<__result_type>(__res);
726 void _M_swap(__basic_future& __that) noexcept
728 _M_state.swap(__that._M_state);
731 // Construction of a future by promise::get_future()
733 __basic_future(const __state_type& __state) : _M_state(__state)
735 _State_base::_S_check(_M_state);
736 _M_state->_M_set_retrieved_flag();
739 // Copy construction from a shared_future
741 __basic_future(const shared_future<_Res>&) noexcept;
743 // Move construction from a shared_future
745 __basic_future(shared_future<_Res>&&) noexcept;
747 // Move construction from a future
749 __basic_future(future<_Res>&&) noexcept;
751 constexpr __basic_future() noexcept : _M_state() { }
755 explicit _Reset(__basic_future& __fut) noexcept : _M_fut(__fut) { }
756 ~_Reset() { _M_fut._M_state.reset(); }
757 __basic_future& _M_fut;
762 /// Primary template for future.
763 template<typename _Res>
764 class future : public __basic_future<_Res>
766 // _GLIBCXX_RESOLVE_LIB_DEFECTS
767 // 3458. Is shared_future intended to work with arrays or function types?
768 static_assert(!is_array<_Res>{}, "result type must not be an array");
769 static_assert(!is_function<_Res>{}, "result type must not be a function");
770 static_assert(is_destructible<_Res>{},
771 "result type must be destructible");
773 friend class promise<_Res>;
774 template<typename> friend class packaged_task;
775 template<typename _Fn, typename... _Args>
776 friend future<__async_result_of<_Fn, _Args...>>
777 async(launch, _Fn&&, _Args&&...);
779 typedef __basic_future<_Res> _Base_type;
780 typedef typename _Base_type::__state_type __state_type;
783 future(const __state_type& __state) : _Base_type(__state) { }
786 constexpr future() noexcept : _Base_type() { }
789 future(future&& __uf) noexcept : _Base_type(std::move(__uf)) { }
792 future(const future&) = delete;
793 future& operator=(const future&) = delete;
795 future& operator=(future&& __fut) noexcept
797 future(std::move(__fut))._M_swap(*this);
801 /// Retrieving the value
805 typename _Base_type::_Reset __reset(*this);
806 return std::move(this->_M_get_result()._M_value());
809 shared_future<_Res> share() noexcept;
812 /// Partial specialization for future<R&>
813 template<typename _Res>
814 class future<_Res&> : public __basic_future<_Res&>
816 friend class promise<_Res&>;
817 template<typename> friend class packaged_task;
818 template<typename _Fn, typename... _Args>
819 friend future<__async_result_of<_Fn, _Args...>>
820 async(launch, _Fn&&, _Args&&...);
822 typedef __basic_future<_Res&> _Base_type;
823 typedef typename _Base_type::__state_type __state_type;
826 future(const __state_type& __state) : _Base_type(__state) { }
829 constexpr future() noexcept : _Base_type() { }
832 future(future&& __uf) noexcept : _Base_type(std::move(__uf)) { }
835 future(const future&) = delete;
836 future& operator=(const future&) = delete;
838 future& operator=(future&& __fut) noexcept
840 future(std::move(__fut))._M_swap(*this);
844 /// Retrieving the value
848 typename _Base_type::_Reset __reset(*this);
849 return this->_M_get_result()._M_get();
852 shared_future<_Res&> share() noexcept;
855 /// Explicit specialization for future<void>
857 class future<void> : public __basic_future<void>
859 friend class promise<void>;
860 template<typename> friend class packaged_task;
861 template<typename _Fn, typename... _Args>
862 friend future<__async_result_of<_Fn, _Args...>>
863 async(launch, _Fn&&, _Args&&...);
865 typedef __basic_future<void> _Base_type;
866 typedef typename _Base_type::__state_type __state_type;
869 future(const __state_type& __state) : _Base_type(__state) { }
872 constexpr future() noexcept : _Base_type() { }
875 future(future&& __uf) noexcept : _Base_type(std::move(__uf)) { }
878 future(const future&) = delete;
879 future& operator=(const future&) = delete;
881 future& operator=(future&& __fut) noexcept
883 future(std::move(__fut))._M_swap(*this);
887 /// Retrieving the value
891 typename _Base_type::_Reset __reset(*this);
892 this->_M_get_result();
895 shared_future<void> share() noexcept;
899 /// Primary template for shared_future.
900 template<typename _Res>
901 class shared_future : public __basic_future<_Res>
903 // _GLIBCXX_RESOLVE_LIB_DEFECTS
904 // 3458. Is shared_future intended to work with arrays or function types?
905 static_assert(!is_array<_Res>{}, "result type must not be an array");
906 static_assert(!is_function<_Res>{}, "result type must not be a function");
907 static_assert(is_destructible<_Res>{},
908 "result type must be destructible");
910 typedef __basic_future<_Res> _Base_type;
913 constexpr shared_future() noexcept : _Base_type() { }
916 shared_future(const shared_future& __sf) noexcept : _Base_type(__sf) { }
918 /// Construct from a future rvalue
919 shared_future(future<_Res>&& __uf) noexcept
920 : _Base_type(std::move(__uf))
923 /// Construct from a shared_future rvalue
924 shared_future(shared_future&& __sf) noexcept
925 : _Base_type(std::move(__sf))
928 shared_future& operator=(const shared_future& __sf) noexcept
930 shared_future(__sf)._M_swap(*this);
934 shared_future& operator=(shared_future&& __sf) noexcept
936 shared_future(std::move(__sf))._M_swap(*this);
940 /// Retrieving the value
942 get() const { return this->_M_get_result()._M_value(); }
945 /// Partial specialization for shared_future<R&>
946 template<typename _Res>
947 class shared_future<_Res&> : public __basic_future<_Res&>
949 typedef __basic_future<_Res&> _Base_type;
952 constexpr shared_future() noexcept : _Base_type() { }
955 shared_future(const shared_future& __sf) : _Base_type(__sf) { }
957 /// Construct from a future rvalue
958 shared_future(future<_Res&>&& __uf) noexcept
959 : _Base_type(std::move(__uf))
962 /// Construct from a shared_future rvalue
963 shared_future(shared_future&& __sf) noexcept
964 : _Base_type(std::move(__sf))
967 shared_future& operator=(const shared_future& __sf)
969 shared_future(__sf)._M_swap(*this);
973 shared_future& operator=(shared_future&& __sf) noexcept
975 shared_future(std::move(__sf))._M_swap(*this);
979 /// Retrieving the value
981 get() const { return this->_M_get_result()._M_get(); }
984 /// Explicit specialization for shared_future<void>
986 class shared_future<void> : public __basic_future<void>
988 typedef __basic_future<void> _Base_type;
991 constexpr shared_future() noexcept : _Base_type() { }
994 shared_future(const shared_future& __sf) : _Base_type(__sf) { }
996 /// Construct from a future rvalue
997 shared_future(future<void>&& __uf) noexcept
998 : _Base_type(std::move(__uf))
1001 /// Construct from a shared_future rvalue
1002 shared_future(shared_future&& __sf) noexcept
1003 : _Base_type(std::move(__sf))
1006 shared_future& operator=(const shared_future& __sf)
1008 shared_future(__sf)._M_swap(*this);
1012 shared_future& operator=(shared_future&& __sf) noexcept
1014 shared_future(std::move(__sf))._M_swap(*this);
1018 // Retrieving the value
1020 get() const { this->_M_get_result(); }
1023 // Now we can define the protected __basic_future constructors.
1024 template<typename _Res>
1025 inline __basic_future<_Res>::
1026 __basic_future(const shared_future<_Res>& __sf) noexcept
1027 : _M_state(__sf._M_state)
1030 template<typename _Res>
1031 inline __basic_future<_Res>::
1032 __basic_future(shared_future<_Res>&& __sf) noexcept
1033 : _M_state(std::move(__sf._M_state))
1036 template<typename _Res>
1037 inline __basic_future<_Res>::
1038 __basic_future(future<_Res>&& __uf) noexcept
1039 : _M_state(std::move(__uf._M_state))
1042 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1043 // 2556. Wide contract for future::share()
1044 template<typename _Res>
1045 inline shared_future<_Res>
1046 future<_Res>::share() noexcept
1047 { return shared_future<_Res>(std::move(*this)); }
1049 template<typename _Res>
1050 inline shared_future<_Res&>
1051 future<_Res&>::share() noexcept
1052 { return shared_future<_Res&>(std::move(*this)); }
1054 inline shared_future<void>
1055 future<void>::share() noexcept
1056 { return shared_future<void>(std::move(*this)); }
1058 /// Primary template for promise
1059 template<typename _Res>
1062 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1063 // 3466: Specify the requirements for promise/future/[...] consistently
1064 static_assert(!is_array<_Res>{}, "result type must not be an array");
1065 static_assert(!is_function<_Res>{}, "result type must not be a function");
1066 static_assert(is_destructible<_Res>{},
1067 "result type must be destructible");
1069 typedef __future_base::_State_base _State;
1070 typedef __future_base::_Result<_Res> _Res_type;
1071 typedef __future_base::_Ptr<_Res_type> _Ptr_type;
1072 template<typename, typename> friend struct _State::_Setter;
1075 shared_ptr<_State> _M_future;
1076 _Ptr_type _M_storage;
1080 : _M_future(std::make_shared<_State>()),
1081 _M_storage(new _Res_type())
1084 promise(promise&& __rhs) noexcept
1085 : _M_future(std::move(__rhs._M_future)),
1086 _M_storage(std::move(__rhs._M_storage))
1089 template<typename _Allocator>
1090 promise(allocator_arg_t, const _Allocator& __a)
1091 : _M_future(std::allocate_shared<_State>(__a)),
1092 _M_storage(__future_base::_S_allocate_result<_Res>(__a))
1095 template<typename _Allocator>
1096 promise(allocator_arg_t, const _Allocator&, promise&& __rhs)
1097 : _M_future(std::move(__rhs._M_future)),
1098 _M_storage(std::move(__rhs._M_storage))
1101 promise(const promise&) = delete;
1105 if (static_cast<bool>(_M_future) && !_M_future.unique())
1106 _M_future->_M_break_promise(std::move(_M_storage));
1111 operator=(promise&& __rhs) noexcept
1113 promise(std::move(__rhs)).swap(*this);
1117 promise& operator=(const promise&) = delete;
1120 swap(promise& __rhs) noexcept
1122 _M_future.swap(__rhs._M_future);
1123 _M_storage.swap(__rhs._M_storage);
1126 // Retrieving the result
1129 { return future<_Res>(_M_future); }
1131 // Setting the result
1133 set_value(const _Res& __r)
1134 { _M_state()._M_set_result(_State::__setter(this, __r)); }
1137 set_value(_Res&& __r)
1138 { _M_state()._M_set_result(_State::__setter(this, std::move(__r))); }
1141 set_exception(exception_ptr __p)
1142 { _M_state()._M_set_result(_State::__setter(__p, this)); }
1145 set_value_at_thread_exit(const _Res& __r)
1147 _M_state()._M_set_delayed_result(_State::__setter(this, __r),
1152 set_value_at_thread_exit(_Res&& __r)
1154 _M_state()._M_set_delayed_result(
1155 _State::__setter(this, std::move(__r)), _M_future);
1159 set_exception_at_thread_exit(exception_ptr __p)
1161 _M_state()._M_set_delayed_result(_State::__setter(__p, this),
1169 __future_base::_State_base::_S_check(_M_future);
1174 template<typename _Res>
1176 swap(promise<_Res>& __x, promise<_Res>& __y) noexcept
1179 template<typename _Res, typename _Alloc>
1180 struct uses_allocator<promise<_Res>, _Alloc>
1181 : public true_type { };
1184 /// Partial specialization for promise<R&>
1185 template<typename _Res>
1186 class promise<_Res&>
1188 typedef __future_base::_State_base _State;
1189 typedef __future_base::_Result<_Res&> _Res_type;
1190 typedef __future_base::_Ptr<_Res_type> _Ptr_type;
1191 template<typename, typename> friend struct _State::_Setter;
1194 shared_ptr<_State> _M_future;
1195 _Ptr_type _M_storage;
1199 : _M_future(std::make_shared<_State>()),
1200 _M_storage(new _Res_type())
1203 promise(promise&& __rhs) noexcept
1204 : _M_future(std::move(__rhs._M_future)),
1205 _M_storage(std::move(__rhs._M_storage))
1208 template<typename _Allocator>
1209 promise(allocator_arg_t, const _Allocator& __a)
1210 : _M_future(std::allocate_shared<_State>(__a)),
1211 _M_storage(__future_base::_S_allocate_result<_Res&>(__a))
1214 template<typename _Allocator>
1215 promise(allocator_arg_t, const _Allocator&, promise&& __rhs)
1216 : _M_future(std::move(__rhs._M_future)),
1217 _M_storage(std::move(__rhs._M_storage))
1220 promise(const promise&) = delete;
1224 if (static_cast<bool>(_M_future) && !_M_future.unique())
1225 _M_future->_M_break_promise(std::move(_M_storage));
1230 operator=(promise&& __rhs) noexcept
1232 promise(std::move(__rhs)).swap(*this);
1236 promise& operator=(const promise&) = delete;
1239 swap(promise& __rhs) noexcept
1241 _M_future.swap(__rhs._M_future);
1242 _M_storage.swap(__rhs._M_storage);
1245 // Retrieving the result
1248 { return future<_Res&>(_M_future); }
1250 // Setting the result
1252 set_value(_Res& __r)
1253 { _M_state()._M_set_result(_State::__setter(this, __r)); }
1256 set_exception(exception_ptr __p)
1257 { _M_state()._M_set_result(_State::__setter(__p, this)); }
1260 set_value_at_thread_exit(_Res& __r)
1262 _M_state()._M_set_delayed_result(_State::__setter(this, __r),
1267 set_exception_at_thread_exit(exception_ptr __p)
1269 _M_state()._M_set_delayed_result(_State::__setter(__p, this),
1277 __future_base::_State_base::_S_check(_M_future);
1282 /// Explicit specialization for promise<void>
1286 typedef __future_base::_State_base _State;
1287 typedef __future_base::_Result<void> _Res_type;
1288 typedef __future_base::_Ptr<_Res_type> _Ptr_type;
1289 template<typename, typename> friend struct _State::_Setter;
1292 shared_ptr<_State> _M_future;
1293 _Ptr_type _M_storage;
1297 : _M_future(std::make_shared<_State>()),
1298 _M_storage(new _Res_type())
1301 promise(promise&& __rhs) noexcept
1302 : _M_future(std::move(__rhs._M_future)),
1303 _M_storage(std::move(__rhs._M_storage))
1306 template<typename _Allocator>
1307 promise(allocator_arg_t, const _Allocator& __a)
1308 : _M_future(std::allocate_shared<_State>(__a)),
1309 _M_storage(__future_base::_S_allocate_result<void>(__a))
1312 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1313 // 2095. missing constructors needed for uses-allocator construction
1314 template<typename _Allocator>
1315 promise(allocator_arg_t, const _Allocator&, promise&& __rhs)
1316 : _M_future(std::move(__rhs._M_future)),
1317 _M_storage(std::move(__rhs._M_storage))
1320 promise(const promise&) = delete;
1324 if (static_cast<bool>(_M_future) && !_M_future.unique())
1325 _M_future->_M_break_promise(std::move(_M_storage));
1330 operator=(promise&& __rhs) noexcept
1332 promise(std::move(__rhs)).swap(*this);
1336 promise& operator=(const promise&) = delete;
1339 swap(promise& __rhs) noexcept
1341 _M_future.swap(__rhs._M_future);
1342 _M_storage.swap(__rhs._M_storage);
1345 // Retrieving the result
1348 { return future<void>(_M_future); }
1350 // Setting the result
1353 { _M_state()._M_set_result(_State::__setter(this)); }
1356 set_exception(exception_ptr __p)
1357 { _M_state()._M_set_result(_State::__setter(__p, this)); }
1360 set_value_at_thread_exit()
1361 { _M_state()._M_set_delayed_result(_State::__setter(this), _M_future); }
1364 set_exception_at_thread_exit(exception_ptr __p)
1366 _M_state()._M_set_delayed_result(_State::__setter(__p, this),
1374 __future_base::_State_base::_S_check(_M_future);
1379 template<typename _Ptr_type, typename _Fn, typename _Res>
1380 struct __future_base::_Task_setter
1382 // Invoke the function and provide the result to the caller.
1383 _Ptr_type operator()() const
1387 (*_M_result)->_M_set((*_M_fn)());
1389 __catch(const __cxxabiv1::__forced_unwind&)
1391 __throw_exception_again; // will cause broken_promise
1395 (*_M_result)->_M_error = current_exception();
1397 return std::move(*_M_result);
1399 _Ptr_type* _M_result;
1403 template<typename _Ptr_type, typename _Fn>
1404 struct __future_base::_Task_setter<_Ptr_type, _Fn, void>
1406 _Ptr_type operator()() const
1412 __catch(const __cxxabiv1::__forced_unwind&)
1414 __throw_exception_again; // will cause broken_promise
1418 (*_M_result)->_M_error = current_exception();
1420 return std::move(*_M_result);
1422 _Ptr_type* _M_result;
1426 // Holds storage for a packaged_task's result.
1427 template<typename _Res, typename... _Args>
1428 struct __future_base::_Task_state_base<_Res(_Args...)>
1429 : __future_base::_State_base
1431 typedef _Res _Res_type;
1433 template<typename _Alloc>
1434 _Task_state_base(const _Alloc& __a)
1435 : _M_result(_S_allocate_result<_Res>(__a))
1438 // Invoke the stored task and make the state ready.
1440 _M_run(_Args&&... __args) = 0;
1442 // Invoke the stored task and make the state ready at thread exit.
1444 _M_run_delayed(_Args&&... __args, weak_ptr<_State_base>) = 0;
1446 virtual shared_ptr<_Task_state_base>
1449 typedef __future_base::_Ptr<_Result<_Res>> _Ptr_type;
1450 _Ptr_type _M_result;
1453 // Holds a packaged_task's stored task.
1454 template<typename _Fn, typename _Alloc, typename _Res, typename... _Args>
1455 struct __future_base::_Task_state<_Fn, _Alloc, _Res(_Args...)> final
1456 : __future_base::_Task_state_base<_Res(_Args...)>
1458 template<typename _Fn2>
1459 _Task_state(_Fn2&& __fn, const _Alloc& __a)
1460 : _Task_state_base<_Res(_Args...)>(__a),
1461 _M_impl(std::forward<_Fn2>(__fn), __a)
1466 _M_run(_Args&&... __args)
1468 auto __boundfn = [&] () -> _Res {
1469 return std::__invoke_r<_Res>(_M_impl._M_fn,
1470 std::forward<_Args>(__args)...);
1472 this->_M_set_result(_S_task_setter(this->_M_result, __boundfn));
1476 _M_run_delayed(_Args&&... __args, weak_ptr<_State_base> __self)
1478 auto __boundfn = [&] () -> _Res {
1479 return std::__invoke_r<_Res>(_M_impl._M_fn,
1480 std::forward<_Args>(__args)...);
1482 this->_M_set_delayed_result(_S_task_setter(this->_M_result, __boundfn),
1486 virtual shared_ptr<_Task_state_base<_Res(_Args...)>>
1489 struct _Impl : _Alloc
1491 template<typename _Fn2>
1492 _Impl(_Fn2&& __fn, const _Alloc& __a)
1493 : _Alloc(__a), _M_fn(std::forward<_Fn2>(__fn)) { }
1498 template<typename _Signature, typename _Fn,
1499 typename _Alloc = std::allocator<int>>
1500 static shared_ptr<__future_base::_Task_state_base<_Signature>>
1501 __create_task_state(_Fn&& __fn, const _Alloc& __a = _Alloc())
1503 typedef typename decay<_Fn>::type _Fn2;
1504 typedef __future_base::_Task_state<_Fn2, _Alloc, _Signature> _State;
1505 return std::allocate_shared<_State>(__a, std::forward<_Fn>(__fn), __a);
1508 template<typename _Fn, typename _Alloc, typename _Res, typename... _Args>
1509 shared_ptr<__future_base::_Task_state_base<_Res(_Args...)>>
1510 __future_base::_Task_state<_Fn, _Alloc, _Res(_Args...)>::_M_reset()
1512 return __create_task_state<_Res(_Args...)>(std::move(_M_impl._M_fn),
1513 static_cast<_Alloc&>(_M_impl));
1517 template<typename _Res, typename... _ArgTypes>
1518 class packaged_task<_Res(_ArgTypes...)>
1520 typedef __future_base::_Task_state_base<_Res(_ArgTypes...)> _State_type;
1521 shared_ptr<_State_type> _M_state;
1523 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1524 // 3039. Unnecessary decay in thread and packaged_task
1525 template<typename _Fn, typename _Fn2 = __remove_cvref_t<_Fn>>
1527 = typename enable_if<!is_same<packaged_task, _Fn2>::value>::type;
1530 // Construction and destruction
1531 packaged_task() noexcept { }
1533 template<typename _Fn, typename = __not_same<_Fn>>
1535 packaged_task(_Fn&& __fn)
1537 __create_task_state<_Res(_ArgTypes...)>(std::forward<_Fn>(__fn)))
1540 #if __cplusplus < 201703L
1541 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1542 // 2097. packaged_task constructors should be constrained
1543 // 2407. [this constructor should not be] explicit
1544 // 2921. packaged_task and type-erased allocators
1545 template<typename _Fn, typename _Alloc, typename = __not_same<_Fn>>
1546 packaged_task(allocator_arg_t, const _Alloc& __a, _Fn&& __fn)
1547 : _M_state(__create_task_state<_Res(_ArgTypes...)>(
1548 std::forward<_Fn>(__fn), __a))
1551 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1552 // 2095. missing constructors needed for uses-allocator construction
1553 template<typename _Allocator>
1554 packaged_task(allocator_arg_t, const _Allocator& __a) noexcept
1557 template<typename _Allocator>
1558 packaged_task(allocator_arg_t, const _Allocator&,
1559 const packaged_task&) = delete;
1561 template<typename _Allocator>
1562 packaged_task(allocator_arg_t, const _Allocator&,
1563 packaged_task&& __other) noexcept
1564 { this->swap(__other); }
1569 if (static_cast<bool>(_M_state) && !_M_state.unique())
1570 _M_state->_M_break_promise(std::move(_M_state->_M_result));
1574 packaged_task(const packaged_task&) = delete;
1575 packaged_task& operator=(const packaged_task&) = delete;
1578 packaged_task(packaged_task&& __other) noexcept
1579 { this->swap(__other); }
1581 packaged_task& operator=(packaged_task&& __other) noexcept
1583 packaged_task(std::move(__other)).swap(*this);
1588 swap(packaged_task& __other) noexcept
1589 { _M_state.swap(__other._M_state); }
1592 valid() const noexcept
1593 { return static_cast<bool>(_M_state); }
1598 { return future<_Res>(_M_state); }
1602 operator()(_ArgTypes... __args)
1604 __future_base::_State_base::_S_check(_M_state);
1605 _M_state->_M_run(std::forward<_ArgTypes>(__args)...);
1609 make_ready_at_thread_exit(_ArgTypes... __args)
1611 __future_base::_State_base::_S_check(_M_state);
1612 _M_state->_M_run_delayed(std::forward<_ArgTypes>(__args)..., _M_state);
1618 __future_base::_State_base::_S_check(_M_state);
1619 packaged_task __tmp;
1620 __tmp._M_state = _M_state;
1621 _M_state = _M_state->_M_reset();
1625 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1626 // 3117. Missing packaged_task deduction guides
1627 #if __cpp_deduction_guides >= 201606
1628 template<typename _Res, typename... _ArgTypes>
1629 packaged_task(_Res(*)(_ArgTypes...)) -> packaged_task<_Res(_ArgTypes...)>;
1631 template<typename _Fun, typename _Signature = typename
1632 __function_guide_helper<decltype(&_Fun::operator())>::type>
1633 packaged_task(_Fun) -> packaged_task<_Signature>;
1637 template<typename _Res, typename... _ArgTypes>
1639 swap(packaged_task<_Res(_ArgTypes...)>& __x,
1640 packaged_task<_Res(_ArgTypes...)>& __y) noexcept
1643 #if __cplusplus < 201703L
1644 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1645 // 2976. Dangling uses_allocator specialization for packaged_task
1646 template<typename _Res, typename _Alloc>
1647 struct uses_allocator<packaged_task<_Res>, _Alloc>
1648 : public true_type { };
1651 // Shared state created by std::async().
1652 // Holds a deferred function and storage for its result.
1653 template<typename _BoundFn, typename _Res>
1654 class __future_base::_Deferred_state final
1655 : public __future_base::_State_base
1658 template<typename... _Args>
1660 _Deferred_state(_Args&&... __args)
1661 : _M_result(new _Result<_Res>()),
1662 _M_fn{{std::forward<_Args>(__args)...}}
1666 typedef __future_base::_Ptr<_Result<_Res>> _Ptr_type;
1667 _Ptr_type _M_result;
1670 // Run the deferred function.
1674 // Multiple threads can call a waiting function on the future and
1675 // reach this point at the same time. The call_once in _M_set_result
1676 // ensures only the first one run the deferred function, stores the
1677 // result in _M_result, swaps that with the base _M_result and makes
1678 // the state ready. Tell _M_set_result to ignore failure so all later
1679 // calls do nothing.
1680 _M_set_result(_S_task_setter(_M_result, _M_fn), true);
1683 // Caller should check whether the state is ready first, because this
1684 // function will return true even after the deferred function has run.
1685 virtual bool _M_is_deferred_future() const { return true; }
1688 // Common functionality hoisted out of the _Async_state_impl template.
1689 class __future_base::_Async_state_commonV2
1690 : public __future_base::_State_base
1693 ~_Async_state_commonV2() = default;
1695 // Make waiting functions block until the thread completes, as if joined.
1697 // This function is used by wait() to satisfy the first requirement below
1698 // and by wait_for() / wait_until() to satisfy the second.
1702 // - a call to a waiting function on an asynchronous return object that
1703 // shares the shared state created by this async call shall block until
1704 // the associated thread has completed, as if joined, or else time out.
1706 // - the associated thread completion synchronizes with the return from
1707 // the first function that successfully detects the ready status of the
1708 // shared state or with the return from the last function that releases
1709 // the shared state, whichever happens first.
1710 virtual void _M_complete_async() { _M_join(); }
1712 void _M_join() { std::call_once(_M_once, &thread::join, &_M_thread); }
1718 // Shared state created by std::async().
1719 // Starts a new thread that runs a function and makes the shared state ready.
1720 template<typename _BoundFn, typename _Res>
1721 class __future_base::_Async_state_impl final
1722 : public __future_base::_Async_state_commonV2
1725 template<typename... _Args>
1727 _Async_state_impl(_Args&&... __args)
1728 : _M_result(new _Result<_Res>()),
1729 _M_fn{{std::forward<_Args>(__args)...}}
1731 _M_thread = std::thread{&_Async_state_impl::_M_run, this};
1734 // Must not destroy _M_result and _M_fn until the thread finishes.
1735 // Call join() directly rather than through _M_join() because no other
1736 // thread can be referring to this state if it is being destroyed.
1737 ~_Async_state_impl()
1739 if (_M_thread.joinable())
1749 _M_set_result(_S_task_setter(_M_result, _M_fn));
1751 __catch (const __cxxabiv1::__forced_unwind&)
1753 // make the shared state ready on thread cancellation
1754 if (static_cast<bool>(_M_result))
1755 this->_M_break_promise(std::move(_M_result));
1756 __throw_exception_again;
1760 typedef __future_base::_Ptr<_Result<_Res>> _Ptr_type;
1761 _Ptr_type _M_result;
1767 template<typename _Fn, typename... _Args>
1768 _GLIBCXX_NODISCARD future<__async_result_of<_Fn, _Args...>>
1769 async(launch __policy, _Fn&& __fn, _Args&&... __args)
1771 using _Wr = std::thread::_Call_wrapper<_Fn, _Args...>;
1772 using _As = __future_base::_Async_state_impl<_Wr>;
1773 using _Ds = __future_base::_Deferred_state<_Wr>;
1775 std::shared_ptr<__future_base::_State_base> __state;
1776 if ((__policy & launch::async) == launch::async)
1780 __state = std::make_shared<_As>(std::forward<_Fn>(__fn),
1781 std::forward<_Args>(__args)...);
1783 #if __cpp_exceptions
1784 catch(const system_error& __e)
1786 if (__e.code() != errc::resource_unavailable_try_again
1787 || (__policy & launch::deferred) != launch::deferred)
1794 __state = std::make_shared<_Ds>(std::forward<_Fn>(__fn),
1795 std::forward<_Args>(__args)...);
1797 return future<__async_result_of<_Fn, _Args...>>(std::move(__state));
1800 /// async, potential overload
1801 template<typename _Fn, typename... _Args>
1802 _GLIBCXX_NODISCARD inline future<__async_result_of<_Fn, _Args...>>
1803 async(_Fn&& __fn, _Args&&... __args)
1805 return std::async(launch::async|launch::deferred,
1806 std::forward<_Fn>(__fn),
1807 std::forward<_Args>(__args)...);
1810 #endif // _GLIBCXX_ASYNC_ABI_COMPAT
1811 #endif // _GLIBCXX_HAS_GTHREADS
1813 /// @} group futures
1814 _GLIBCXX_END_NAMESPACE_VERSION
1819 #endif // _GLIBCXX_FUTURE