1 // <future> -*- C++ -*-
3 // Copyright (C) 2009-2020 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>
40 #include <condition_variable>
41 #include <system_error>
43 #include <bits/atomic_futex.h>
44 #include <bits/functexcept.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/uses_allocator.h>
50 #include <bits/allocated_ptr.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)
145 return static_cast<launch>(
146 static_cast<int>(__x) & static_cast<int>(__y));
149 constexpr launch operator|(launch __x, launch __y)
151 return static_cast<launch>(
152 static_cast<int>(__x) | static_cast<int>(__y));
155 constexpr launch operator^(launch __x, launch __y)
157 return static_cast<launch>(
158 static_cast<int>(__x) ^ static_cast<int>(__y));
161 constexpr launch operator~(launch __x)
162 { return static_cast<launch>(~static_cast<int>(__x)); }
164 inline launch& operator&=(launch& __x, launch __y)
165 { return __x = __x & __y; }
167 inline launch& operator|=(launch& __x, launch __y)
168 { return __x = __x | __y; }
170 inline launch& operator^=(launch& __x, launch __y)
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;
349 if (_M_is_deferred_future())
350 return future_status::deferred;
351 if (_M_status._M_load_when_equal_for(_Status::__ready,
352 memory_order_acquire, __rel))
354 // _GLIBCXX_RESOLVE_LIB_DEFECTS
355 // 2100. timed waiting functions must also join
356 // This call is a no-op by default except on an async future,
357 // in which case the async thread is joined. It's also not a
358 // no-op for a deferred future, but such a future will never
359 // reach this point because it returns future_status::deferred
360 // instead of waiting for the future to become ready (see
361 // above). Async futures synchronize in this call, so we need
362 // no further synchronization here.
365 return future_status::ready;
367 return future_status::timeout;
370 template<typename _Clock, typename _Duration>
372 wait_until(const chrono::time_point<_Clock, _Duration>& __abs)
374 #if __cplusplus > 201703L
375 static_assert(chrono::is_clock_v<_Clock>);
377 // First, check if the future has been made ready. Use acquire MO
378 // to synchronize with the thread that made it ready.
379 if (_M_status._M_load(memory_order_acquire) == _Status::__ready)
380 return future_status::ready;
381 if (_M_is_deferred_future())
382 return future_status::deferred;
383 if (_M_status._M_load_when_equal_until(_Status::__ready,
384 memory_order_acquire, __abs))
386 // _GLIBCXX_RESOLVE_LIB_DEFECTS
387 // 2100. timed waiting functions must also join
388 // See wait_for(...) above.
391 return future_status::ready;
393 return future_status::timeout;
396 // Provide a result to the shared state and make it ready.
397 // Calls at most once: _M_result = __res();
399 _M_set_result(function<_Ptr_type()> __res, bool __ignore_failure = false)
401 bool __did_set = false;
402 // all calls to this function are serialized,
403 // side-effects of invoking __res only happen once
404 call_once(_M_once, &_State_baseV2::_M_do_set, this,
405 std::__addressof(__res), std::__addressof(__did_set));
407 // Use release MO to synchronize with observers of the ready state.
408 _M_status._M_store_notify_all(_Status::__ready,
409 memory_order_release);
410 else if (!__ignore_failure)
411 __throw_future_error(int(future_errc::promise_already_satisfied));
414 // Provide a result to the shared state but delay making it ready
415 // until the calling thread exits.
416 // Calls at most once: _M_result = __res();
418 _M_set_delayed_result(function<_Ptr_type()> __res,
419 weak_ptr<_State_baseV2> __self)
421 bool __did_set = false;
422 unique_ptr<_Make_ready> __mr{new _Make_ready};
423 // all calls to this function are serialized,
424 // side-effects of invoking __res only happen once
425 call_once(_M_once, &_State_baseV2::_M_do_set, this,
426 std::__addressof(__res), std::__addressof(__did_set));
428 __throw_future_error(int(future_errc::promise_already_satisfied));
429 __mr->_M_shared_state = std::move(__self);
434 // Abandon this shared state.
436 _M_break_promise(_Ptr_type __res)
438 if (static_cast<bool>(__res))
441 make_exception_ptr(future_error(future_errc::broken_promise));
442 // This function is only called when the last asynchronous result
443 // provider is abandoning this shared state, so noone can be
444 // trying to make the shared state ready at the same time, and
445 // we can access _M_result directly instead of through call_once.
446 _M_result.swap(__res);
447 // Use release MO to synchronize with observers of the ready state.
448 _M_status._M_store_notify_all(_Status::__ready,
449 memory_order_release);
453 // Called when this object is first passed to a future.
455 _M_set_retrieved_flag()
457 if (_M_retrieved.test_and_set())
458 __throw_future_error(int(future_errc::future_already_retrieved));
461 template<typename _Res, typename _Arg>
465 template<typename _Res, typename _Arg>
466 struct _Setter<_Res, _Arg&>
468 // check this is only used by promise<R>::set_value(const R&)
469 // or promise<R&>::set_value(R&)
470 static_assert(is_same<_Res, _Arg&>::value // promise<R&>
471 || is_same<const _Res, _Arg>::value, // promise<R>
472 "Invalid specialisation");
474 // Used by std::promise to copy construct the result.
475 typename promise<_Res>::_Ptr_type operator()() const
477 _M_promise->_M_storage->_M_set(*_M_arg);
478 return std::move(_M_promise->_M_storage);
480 promise<_Res>* _M_promise;
485 template<typename _Res>
486 struct _Setter<_Res, _Res&&>
488 // Used by std::promise to move construct the result.
489 typename promise<_Res>::_Ptr_type operator()() const
491 _M_promise->_M_storage->_M_set(std::move(*_M_arg));
492 return std::move(_M_promise->_M_storage);
494 promise<_Res>* _M_promise;
499 template<typename _Res>
500 struct _Setter<_Res, void>
502 static_assert(is_void<_Res>::value, "Only used for promise<void>");
504 typename promise<_Res>::_Ptr_type operator()() const
505 { return std::move(_M_promise->_M_storage); }
507 promise<_Res>* _M_promise;
510 struct __exception_ptr_tag { };
513 template<typename _Res>
514 struct _Setter<_Res, __exception_ptr_tag>
516 // Used by std::promise to store an exception as the result.
517 typename promise<_Res>::_Ptr_type operator()() const
519 _M_promise->_M_storage->_M_error = *_M_ex;
520 return std::move(_M_promise->_M_storage);
523 promise<_Res>* _M_promise;
524 exception_ptr* _M_ex;
527 template<typename _Res, typename _Arg>
528 static _Setter<_Res, _Arg&&>
529 __setter(promise<_Res>* __prom, _Arg&& __arg)
531 _S_check(__prom->_M_future);
532 return _Setter<_Res, _Arg&&>{ __prom, std::__addressof(__arg) };
535 template<typename _Res>
536 static _Setter<_Res, __exception_ptr_tag>
537 __setter(exception_ptr& __ex, promise<_Res>* __prom)
539 _S_check(__prom->_M_future);
540 return _Setter<_Res, __exception_ptr_tag>{ __prom, &__ex };
543 template<typename _Res>
544 static _Setter<_Res, void>
545 __setter(promise<_Res>* __prom)
547 _S_check(__prom->_M_future);
548 return _Setter<_Res, void>{ __prom };
551 template<typename _Tp>
553 _S_check(const shared_ptr<_Tp>& __p)
555 if (!static_cast<bool>(__p))
556 __throw_future_error((int)future_errc::no_state);
560 // The function invoked with std::call_once(_M_once, ...).
562 _M_do_set(function<_Ptr_type()>* __f, bool* __did_set)
564 _Ptr_type __res = (*__f)();
565 // Notify the caller that we did try to set; if we do not throw an
566 // exception, the caller will be aware that it did set (e.g., see
569 _M_result.swap(__res); // nothrow
572 // Wait for completion of async function.
573 virtual void _M_complete_async() { }
575 // Return true if state corresponds to a deferred function.
576 virtual bool _M_is_deferred_future() const { return false; }
578 struct _Make_ready final : __at_thread_exit_elt
580 weak_ptr<_State_baseV2> _M_shared_state;
581 static void _S_run(void*);
586 #ifdef _GLIBCXX_ASYNC_ABI_COMPAT
588 class _Async_state_common;
590 using _State_base = _State_baseV2;
591 class _Async_state_commonV2;
594 template<typename _BoundFn,
595 typename _Res = decltype(std::declval<_BoundFn&>()())>
596 class _Deferred_state;
598 template<typename _BoundFn,
599 typename _Res = decltype(std::declval<_BoundFn&>()())>
600 class _Async_state_impl;
602 template<typename _Signature>
603 class _Task_state_base;
605 template<typename _Fn, typename _Alloc, typename _Signature>
608 template<typename _BoundFn>
609 static std::shared_ptr<_State_base>
610 _S_make_deferred_state(_BoundFn&& __fn);
612 template<typename _BoundFn>
613 static std::shared_ptr<_State_base>
614 _S_make_async_state(_BoundFn&& __fn);
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 == 0))
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 friend class promise<_Res>;
767 template<typename> friend class packaged_task;
768 template<typename _Fn, typename... _Args>
769 friend future<__async_result_of<_Fn, _Args...>>
770 async(launch, _Fn&&, _Args&&...);
772 typedef __basic_future<_Res> _Base_type;
773 typedef typename _Base_type::__state_type __state_type;
776 future(const __state_type& __state) : _Base_type(__state) { }
779 constexpr future() noexcept : _Base_type() { }
782 future(future&& __uf) noexcept : _Base_type(std::move(__uf)) { }
785 future(const future&) = delete;
786 future& operator=(const future&) = delete;
788 future& operator=(future&& __fut) noexcept
790 future(std::move(__fut))._M_swap(*this);
794 /// Retrieving the value
798 typename _Base_type::_Reset __reset(*this);
799 return std::move(this->_M_get_result()._M_value());
802 shared_future<_Res> share() noexcept;
805 /// Partial specialization for future<R&>
806 template<typename _Res>
807 class future<_Res&> : public __basic_future<_Res&>
809 friend class promise<_Res&>;
810 template<typename> friend class packaged_task;
811 template<typename _Fn, typename... _Args>
812 friend future<__async_result_of<_Fn, _Args...>>
813 async(launch, _Fn&&, _Args&&...);
815 typedef __basic_future<_Res&> _Base_type;
816 typedef typename _Base_type::__state_type __state_type;
819 future(const __state_type& __state) : _Base_type(__state) { }
822 constexpr future() noexcept : _Base_type() { }
825 future(future&& __uf) noexcept : _Base_type(std::move(__uf)) { }
828 future(const future&) = delete;
829 future& operator=(const future&) = delete;
831 future& operator=(future&& __fut) noexcept
833 future(std::move(__fut))._M_swap(*this);
837 /// Retrieving the value
841 typename _Base_type::_Reset __reset(*this);
842 return this->_M_get_result()._M_get();
845 shared_future<_Res&> share() noexcept;
848 /// Explicit specialization for future<void>
850 class future<void> : public __basic_future<void>
852 friend class promise<void>;
853 template<typename> friend class packaged_task;
854 template<typename _Fn, typename... _Args>
855 friend future<__async_result_of<_Fn, _Args...>>
856 async(launch, _Fn&&, _Args&&...);
858 typedef __basic_future<void> _Base_type;
859 typedef typename _Base_type::__state_type __state_type;
862 future(const __state_type& __state) : _Base_type(__state) { }
865 constexpr future() noexcept : _Base_type() { }
868 future(future&& __uf) noexcept : _Base_type(std::move(__uf)) { }
871 future(const future&) = delete;
872 future& operator=(const future&) = delete;
874 future& operator=(future&& __fut) noexcept
876 future(std::move(__fut))._M_swap(*this);
880 /// Retrieving the value
884 typename _Base_type::_Reset __reset(*this);
885 this->_M_get_result();
888 shared_future<void> share() noexcept;
892 /// Primary template for shared_future.
893 template<typename _Res>
894 class shared_future : public __basic_future<_Res>
896 typedef __basic_future<_Res> _Base_type;
899 constexpr shared_future() noexcept : _Base_type() { }
902 shared_future(const shared_future& __sf) noexcept : _Base_type(__sf) { }
904 /// Construct from a future rvalue
905 shared_future(future<_Res>&& __uf) noexcept
906 : _Base_type(std::move(__uf))
909 /// Construct from a shared_future rvalue
910 shared_future(shared_future&& __sf) noexcept
911 : _Base_type(std::move(__sf))
914 shared_future& operator=(const shared_future& __sf) noexcept
916 shared_future(__sf)._M_swap(*this);
920 shared_future& operator=(shared_future&& __sf) noexcept
922 shared_future(std::move(__sf))._M_swap(*this);
926 /// Retrieving the value
928 get() const { return this->_M_get_result()._M_value(); }
931 /// Partial specialization for shared_future<R&>
932 template<typename _Res>
933 class shared_future<_Res&> : public __basic_future<_Res&>
935 typedef __basic_future<_Res&> _Base_type;
938 constexpr shared_future() noexcept : _Base_type() { }
941 shared_future(const shared_future& __sf) : _Base_type(__sf) { }
943 /// Construct from a future rvalue
944 shared_future(future<_Res&>&& __uf) noexcept
945 : _Base_type(std::move(__uf))
948 /// Construct from a shared_future rvalue
949 shared_future(shared_future&& __sf) noexcept
950 : _Base_type(std::move(__sf))
953 shared_future& operator=(const shared_future& __sf)
955 shared_future(__sf)._M_swap(*this);
959 shared_future& operator=(shared_future&& __sf) noexcept
961 shared_future(std::move(__sf))._M_swap(*this);
965 /// Retrieving the value
967 get() const { return this->_M_get_result()._M_get(); }
970 /// Explicit specialization for shared_future<void>
972 class shared_future<void> : public __basic_future<void>
974 typedef __basic_future<void> _Base_type;
977 constexpr shared_future() noexcept : _Base_type() { }
980 shared_future(const shared_future& __sf) : _Base_type(__sf) { }
982 /// Construct from a future rvalue
983 shared_future(future<void>&& __uf) noexcept
984 : _Base_type(std::move(__uf))
987 /// Construct from a shared_future rvalue
988 shared_future(shared_future&& __sf) noexcept
989 : _Base_type(std::move(__sf))
992 shared_future& operator=(const shared_future& __sf)
994 shared_future(__sf)._M_swap(*this);
998 shared_future& operator=(shared_future&& __sf) noexcept
1000 shared_future(std::move(__sf))._M_swap(*this);
1004 // Retrieving the value
1006 get() const { this->_M_get_result(); }
1009 // Now we can define the protected __basic_future constructors.
1010 template<typename _Res>
1011 inline __basic_future<_Res>::
1012 __basic_future(const shared_future<_Res>& __sf) noexcept
1013 : _M_state(__sf._M_state)
1016 template<typename _Res>
1017 inline __basic_future<_Res>::
1018 __basic_future(shared_future<_Res>&& __sf) noexcept
1019 : _M_state(std::move(__sf._M_state))
1022 template<typename _Res>
1023 inline __basic_future<_Res>::
1024 __basic_future(future<_Res>&& __uf) noexcept
1025 : _M_state(std::move(__uf._M_state))
1028 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1029 // 2556. Wide contract for future::share()
1030 template<typename _Res>
1031 inline shared_future<_Res>
1032 future<_Res>::share() noexcept
1033 { return shared_future<_Res>(std::move(*this)); }
1035 template<typename _Res>
1036 inline shared_future<_Res&>
1037 future<_Res&>::share() noexcept
1038 { return shared_future<_Res&>(std::move(*this)); }
1040 inline shared_future<void>
1041 future<void>::share() noexcept
1042 { return shared_future<void>(std::move(*this)); }
1044 /// Primary template for promise
1045 template<typename _Res>
1048 typedef __future_base::_State_base _State;
1049 typedef __future_base::_Result<_Res> _Res_type;
1050 typedef __future_base::_Ptr<_Res_type> _Ptr_type;
1051 template<typename, typename> friend class _State::_Setter;
1054 shared_ptr<_State> _M_future;
1055 _Ptr_type _M_storage;
1059 : _M_future(std::make_shared<_State>()),
1060 _M_storage(new _Res_type())
1063 promise(promise&& __rhs) noexcept
1064 : _M_future(std::move(__rhs._M_future)),
1065 _M_storage(std::move(__rhs._M_storage))
1068 template<typename _Allocator>
1069 promise(allocator_arg_t, const _Allocator& __a)
1070 : _M_future(std::allocate_shared<_State>(__a)),
1071 _M_storage(__future_base::_S_allocate_result<_Res>(__a))
1074 template<typename _Allocator>
1075 promise(allocator_arg_t, const _Allocator&, promise&& __rhs)
1076 : _M_future(std::move(__rhs._M_future)),
1077 _M_storage(std::move(__rhs._M_storage))
1080 promise(const promise&) = delete;
1084 if (static_cast<bool>(_M_future) && !_M_future.unique())
1085 _M_future->_M_break_promise(std::move(_M_storage));
1090 operator=(promise&& __rhs) noexcept
1092 promise(std::move(__rhs)).swap(*this);
1096 promise& operator=(const promise&) = delete;
1099 swap(promise& __rhs) noexcept
1101 _M_future.swap(__rhs._M_future);
1102 _M_storage.swap(__rhs._M_storage);
1105 // Retrieving the result
1108 { return future<_Res>(_M_future); }
1110 // Setting the result
1112 set_value(const _Res& __r)
1113 { _M_future->_M_set_result(_State::__setter(this, __r)); }
1116 set_value(_Res&& __r)
1117 { _M_future->_M_set_result(_State::__setter(this, std::move(__r))); }
1120 set_exception(exception_ptr __p)
1121 { _M_future->_M_set_result(_State::__setter(__p, this)); }
1124 set_value_at_thread_exit(const _Res& __r)
1126 _M_future->_M_set_delayed_result(_State::__setter(this, __r),
1131 set_value_at_thread_exit(_Res&& __r)
1133 _M_future->_M_set_delayed_result(
1134 _State::__setter(this, std::move(__r)), _M_future);
1138 set_exception_at_thread_exit(exception_ptr __p)
1140 _M_future->_M_set_delayed_result(_State::__setter(__p, this),
1145 template<typename _Res>
1147 swap(promise<_Res>& __x, promise<_Res>& __y) noexcept
1150 template<typename _Res, typename _Alloc>
1151 struct uses_allocator<promise<_Res>, _Alloc>
1152 : public true_type { };
1155 /// Partial specialization for promise<R&>
1156 template<typename _Res>
1157 class promise<_Res&>
1159 typedef __future_base::_State_base _State;
1160 typedef __future_base::_Result<_Res&> _Res_type;
1161 typedef __future_base::_Ptr<_Res_type> _Ptr_type;
1162 template<typename, typename> friend class _State::_Setter;
1165 shared_ptr<_State> _M_future;
1166 _Ptr_type _M_storage;
1170 : _M_future(std::make_shared<_State>()),
1171 _M_storage(new _Res_type())
1174 promise(promise&& __rhs) noexcept
1175 : _M_future(std::move(__rhs._M_future)),
1176 _M_storage(std::move(__rhs._M_storage))
1179 template<typename _Allocator>
1180 promise(allocator_arg_t, const _Allocator& __a)
1181 : _M_future(std::allocate_shared<_State>(__a)),
1182 _M_storage(__future_base::_S_allocate_result<_Res&>(__a))
1185 template<typename _Allocator>
1186 promise(allocator_arg_t, const _Allocator&, promise&& __rhs)
1187 : _M_future(std::move(__rhs._M_future)),
1188 _M_storage(std::move(__rhs._M_storage))
1191 promise(const promise&) = delete;
1195 if (static_cast<bool>(_M_future) && !_M_future.unique())
1196 _M_future->_M_break_promise(std::move(_M_storage));
1201 operator=(promise&& __rhs) noexcept
1203 promise(std::move(__rhs)).swap(*this);
1207 promise& operator=(const promise&) = delete;
1210 swap(promise& __rhs) noexcept
1212 _M_future.swap(__rhs._M_future);
1213 _M_storage.swap(__rhs._M_storage);
1216 // Retrieving the result
1219 { return future<_Res&>(_M_future); }
1221 // Setting the result
1223 set_value(_Res& __r)
1224 { _M_future->_M_set_result(_State::__setter(this, __r)); }
1227 set_exception(exception_ptr __p)
1228 { _M_future->_M_set_result(_State::__setter(__p, this)); }
1231 set_value_at_thread_exit(_Res& __r)
1233 _M_future->_M_set_delayed_result(_State::__setter(this, __r),
1238 set_exception_at_thread_exit(exception_ptr __p)
1240 _M_future->_M_set_delayed_result(_State::__setter(__p, this),
1245 /// Explicit specialization for promise<void>
1249 typedef __future_base::_State_base _State;
1250 typedef __future_base::_Result<void> _Res_type;
1251 typedef __future_base::_Ptr<_Res_type> _Ptr_type;
1252 template<typename, typename> friend class _State::_Setter;
1255 shared_ptr<_State> _M_future;
1256 _Ptr_type _M_storage;
1260 : _M_future(std::make_shared<_State>()),
1261 _M_storage(new _Res_type())
1264 promise(promise&& __rhs) noexcept
1265 : _M_future(std::move(__rhs._M_future)),
1266 _M_storage(std::move(__rhs._M_storage))
1269 template<typename _Allocator>
1270 promise(allocator_arg_t, const _Allocator& __a)
1271 : _M_future(std::allocate_shared<_State>(__a)),
1272 _M_storage(__future_base::_S_allocate_result<void>(__a))
1275 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1276 // 2095. missing constructors needed for uses-allocator construction
1277 template<typename _Allocator>
1278 promise(allocator_arg_t, const _Allocator&, promise&& __rhs)
1279 : _M_future(std::move(__rhs._M_future)),
1280 _M_storage(std::move(__rhs._M_storage))
1283 promise(const promise&) = delete;
1287 if (static_cast<bool>(_M_future) && !_M_future.unique())
1288 _M_future->_M_break_promise(std::move(_M_storage));
1293 operator=(promise&& __rhs) noexcept
1295 promise(std::move(__rhs)).swap(*this);
1299 promise& operator=(const promise&) = delete;
1302 swap(promise& __rhs) noexcept
1304 _M_future.swap(__rhs._M_future);
1305 _M_storage.swap(__rhs._M_storage);
1308 // Retrieving the result
1311 { return future<void>(_M_future); }
1313 // Setting the result
1316 { _M_future->_M_set_result(_State::__setter(this)); }
1319 set_exception(exception_ptr __p)
1320 { _M_future->_M_set_result(_State::__setter(__p, this)); }
1323 set_value_at_thread_exit()
1324 { _M_future->_M_set_delayed_result(_State::__setter(this), _M_future); }
1327 set_exception_at_thread_exit(exception_ptr __p)
1329 _M_future->_M_set_delayed_result(_State::__setter(__p, this),
1334 template<typename _Ptr_type, typename _Fn, typename _Res>
1335 struct __future_base::_Task_setter
1337 // Invoke the function and provide the result to the caller.
1338 _Ptr_type operator()() const
1342 (*_M_result)->_M_set((*_M_fn)());
1344 __catch(const __cxxabiv1::__forced_unwind&)
1346 __throw_exception_again; // will cause broken_promise
1350 (*_M_result)->_M_error = current_exception();
1352 return std::move(*_M_result);
1354 _Ptr_type* _M_result;
1358 template<typename _Ptr_type, typename _Fn>
1359 struct __future_base::_Task_setter<_Ptr_type, _Fn, void>
1361 _Ptr_type operator()() const
1367 __catch(const __cxxabiv1::__forced_unwind&)
1369 __throw_exception_again; // will cause broken_promise
1373 (*_M_result)->_M_error = current_exception();
1375 return std::move(*_M_result);
1377 _Ptr_type* _M_result;
1381 // Holds storage for a packaged_task's result.
1382 template<typename _Res, typename... _Args>
1383 struct __future_base::_Task_state_base<_Res(_Args...)>
1384 : __future_base::_State_base
1386 typedef _Res _Res_type;
1388 template<typename _Alloc>
1389 _Task_state_base(const _Alloc& __a)
1390 : _M_result(_S_allocate_result<_Res>(__a))
1393 // Invoke the stored task and make the state ready.
1395 _M_run(_Args&&... __args) = 0;
1397 // Invoke the stored task and make the state ready at thread exit.
1399 _M_run_delayed(_Args&&... __args, weak_ptr<_State_base>) = 0;
1401 virtual shared_ptr<_Task_state_base>
1404 typedef __future_base::_Ptr<_Result<_Res>> _Ptr_type;
1405 _Ptr_type _M_result;
1408 // Holds a packaged_task's stored task.
1409 template<typename _Fn, typename _Alloc, typename _Res, typename... _Args>
1410 struct __future_base::_Task_state<_Fn, _Alloc, _Res(_Args...)> final
1411 : __future_base::_Task_state_base<_Res(_Args...)>
1413 template<typename _Fn2>
1414 _Task_state(_Fn2&& __fn, const _Alloc& __a)
1415 : _Task_state_base<_Res(_Args...)>(__a),
1416 _M_impl(std::forward<_Fn2>(__fn), __a)
1421 _M_run(_Args&&... __args)
1423 auto __boundfn = [&] () -> _Res {
1424 return std::__invoke_r<_Res>(_M_impl._M_fn,
1425 std::forward<_Args>(__args)...);
1427 this->_M_set_result(_S_task_setter(this->_M_result, __boundfn));
1431 _M_run_delayed(_Args&&... __args, weak_ptr<_State_base> __self)
1433 auto __boundfn = [&] () -> _Res {
1434 return std::__invoke_r<_Res>(_M_impl._M_fn,
1435 std::forward<_Args>(__args)...);
1437 this->_M_set_delayed_result(_S_task_setter(this->_M_result, __boundfn),
1441 virtual shared_ptr<_Task_state_base<_Res(_Args...)>>
1444 struct _Impl : _Alloc
1446 template<typename _Fn2>
1447 _Impl(_Fn2&& __fn, const _Alloc& __a)
1448 : _Alloc(__a), _M_fn(std::forward<_Fn2>(__fn)) { }
1453 template<typename _Signature, typename _Fn,
1454 typename _Alloc = std::allocator<int>>
1455 static shared_ptr<__future_base::_Task_state_base<_Signature>>
1456 __create_task_state(_Fn&& __fn, const _Alloc& __a = _Alloc())
1458 typedef typename decay<_Fn>::type _Fn2;
1459 typedef __future_base::_Task_state<_Fn2, _Alloc, _Signature> _State;
1460 return std::allocate_shared<_State>(__a, std::forward<_Fn>(__fn), __a);
1463 template<typename _Fn, typename _Alloc, typename _Res, typename... _Args>
1464 shared_ptr<__future_base::_Task_state_base<_Res(_Args...)>>
1465 __future_base::_Task_state<_Fn, _Alloc, _Res(_Args...)>::_M_reset()
1467 return __create_task_state<_Res(_Args...)>(std::move(_M_impl._M_fn),
1468 static_cast<_Alloc&>(_M_impl));
1472 template<typename _Res, typename... _ArgTypes>
1473 class packaged_task<_Res(_ArgTypes...)>
1475 typedef __future_base::_Task_state_base<_Res(_ArgTypes...)> _State_type;
1476 shared_ptr<_State_type> _M_state;
1478 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1479 // 3039. Unnecessary decay in thread and packaged_task
1480 template<typename _Fn, typename _Fn2 = __remove_cvref_t<_Fn>>
1482 = typename enable_if<!is_same<packaged_task, _Fn2>::value>::type;
1485 // Construction and destruction
1486 packaged_task() noexcept { }
1488 template<typename _Fn, typename = __not_same<_Fn>>
1490 packaged_task(_Fn&& __fn)
1492 __create_task_state<_Res(_ArgTypes...)>(std::forward<_Fn>(__fn)))
1495 #if __cplusplus < 201703L
1496 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1497 // 2097. packaged_task constructors should be constrained
1498 // 2407. [this constructor should not be] explicit
1499 // 2921. packaged_task and type-erased allocators
1500 template<typename _Fn, typename _Alloc, typename = __not_same<_Fn>>
1501 packaged_task(allocator_arg_t, const _Alloc& __a, _Fn&& __fn)
1502 : _M_state(__create_task_state<_Res(_ArgTypes...)>(
1503 std::forward<_Fn>(__fn), __a))
1506 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1507 // 2095. missing constructors needed for uses-allocator construction
1508 template<typename _Allocator>
1509 packaged_task(allocator_arg_t, const _Allocator& __a) noexcept
1512 template<typename _Allocator>
1513 packaged_task(allocator_arg_t, const _Allocator&,
1514 const packaged_task&) = delete;
1516 template<typename _Allocator>
1517 packaged_task(allocator_arg_t, const _Allocator&,
1518 packaged_task&& __other) noexcept
1519 { this->swap(__other); }
1524 if (static_cast<bool>(_M_state) && !_M_state.unique())
1525 _M_state->_M_break_promise(std::move(_M_state->_M_result));
1529 packaged_task(const packaged_task&) = delete;
1530 packaged_task& operator=(const packaged_task&) = delete;
1533 packaged_task(packaged_task&& __other) noexcept
1534 { this->swap(__other); }
1536 packaged_task& operator=(packaged_task&& __other) noexcept
1538 packaged_task(std::move(__other)).swap(*this);
1543 swap(packaged_task& __other) noexcept
1544 { _M_state.swap(__other._M_state); }
1547 valid() const noexcept
1548 { return static_cast<bool>(_M_state); }
1553 { return future<_Res>(_M_state); }
1557 operator()(_ArgTypes... __args)
1559 __future_base::_State_base::_S_check(_M_state);
1560 _M_state->_M_run(std::forward<_ArgTypes>(__args)...);
1564 make_ready_at_thread_exit(_ArgTypes... __args)
1566 __future_base::_State_base::_S_check(_M_state);
1567 _M_state->_M_run_delayed(std::forward<_ArgTypes>(__args)..., _M_state);
1573 __future_base::_State_base::_S_check(_M_state);
1574 packaged_task __tmp;
1575 __tmp._M_state = _M_state;
1576 _M_state = _M_state->_M_reset();
1581 template<typename _Res, typename... _ArgTypes>
1583 swap(packaged_task<_Res(_ArgTypes...)>& __x,
1584 packaged_task<_Res(_ArgTypes...)>& __y) noexcept
1587 #if __cplusplus < 201703L
1588 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1589 // 2976. Dangling uses_allocator specialization for packaged_task
1590 template<typename _Res, typename _Alloc>
1591 struct uses_allocator<packaged_task<_Res>, _Alloc>
1592 : public true_type { };
1595 // Shared state created by std::async().
1596 // Holds a deferred function and storage for its result.
1597 template<typename _BoundFn, typename _Res>
1598 class __future_base::_Deferred_state final
1599 : public __future_base::_State_base
1603 _Deferred_state(_BoundFn&& __fn)
1604 : _M_result(new _Result<_Res>()), _M_fn(std::move(__fn))
1608 typedef __future_base::_Ptr<_Result<_Res>> _Ptr_type;
1609 _Ptr_type _M_result;
1612 // Run the deferred function.
1616 // Multiple threads can call a waiting function on the future and
1617 // reach this point at the same time. The call_once in _M_set_result
1618 // ensures only the first one run the deferred function, stores the
1619 // result in _M_result, swaps that with the base _M_result and makes
1620 // the state ready. Tell _M_set_result to ignore failure so all later
1621 // calls do nothing.
1622 _M_set_result(_S_task_setter(_M_result, _M_fn), true);
1625 // Caller should check whether the state is ready first, because this
1626 // function will return true even after the deferred function has run.
1627 virtual bool _M_is_deferred_future() const { return true; }
1630 // Common functionality hoisted out of the _Async_state_impl template.
1631 class __future_base::_Async_state_commonV2
1632 : public __future_base::_State_base
1635 ~_Async_state_commonV2() = default;
1637 // Make waiting functions block until the thread completes, as if joined.
1639 // This function is used by wait() to satisfy the first requirement below
1640 // and by wait_for() / wait_until() to satisfy the second.
1644 // - a call to a waiting function on an asynchronous return object that
1645 // shares the shared state created by this async call shall block until
1646 // the associated thread has completed, as if joined, or else time out.
1648 // - the associated thread completion synchronizes with the return from
1649 // the first function that successfully detects the ready status of the
1650 // shared state or with the return from the last function that releases
1651 // the shared state, whichever happens first.
1652 virtual void _M_complete_async() { _M_join(); }
1654 void _M_join() { std::call_once(_M_once, &thread::join, &_M_thread); }
1660 // Shared state created by std::async().
1661 // Starts a new thread that runs a function and makes the shared state ready.
1662 template<typename _BoundFn, typename _Res>
1663 class __future_base::_Async_state_impl final
1664 : public __future_base::_Async_state_commonV2
1668 _Async_state_impl(_BoundFn&& __fn)
1669 : _M_result(new _Result<_Res>()), _M_fn(std::move(__fn))
1671 _M_thread = std::thread{ [this] {
1674 _M_set_result(_S_task_setter(_M_result, _M_fn));
1676 __catch (const __cxxabiv1::__forced_unwind&)
1678 // make the shared state ready on thread cancellation
1679 if (static_cast<bool>(_M_result))
1680 this->_M_break_promise(std::move(_M_result));
1681 __throw_exception_again;
1686 // Must not destroy _M_result and _M_fn until the thread finishes.
1687 // Call join() directly rather than through _M_join() because no other
1688 // thread can be referring to this state if it is being destroyed.
1689 ~_Async_state_impl() { if (_M_thread.joinable()) _M_thread.join(); }
1692 typedef __future_base::_Ptr<_Result<_Res>> _Ptr_type;
1693 _Ptr_type _M_result;
1697 template<typename _BoundFn>
1698 inline std::shared_ptr<__future_base::_State_base>
1699 __future_base::_S_make_deferred_state(_BoundFn&& __fn)
1701 typedef typename remove_reference<_BoundFn>::type __fn_type;
1702 typedef _Deferred_state<__fn_type> __state_type;
1703 return std::make_shared<__state_type>(std::move(__fn));
1706 template<typename _BoundFn>
1707 inline std::shared_ptr<__future_base::_State_base>
1708 __future_base::_S_make_async_state(_BoundFn&& __fn)
1710 typedef typename remove_reference<_BoundFn>::type __fn_type;
1711 typedef _Async_state_impl<__fn_type> __state_type;
1712 return std::make_shared<__state_type>(std::move(__fn));
1717 template<typename _Fn, typename... _Args>
1718 _GLIBCXX_NODISCARD future<__async_result_of<_Fn, _Args...>>
1719 async(launch __policy, _Fn&& __fn, _Args&&... __args)
1721 std::shared_ptr<__future_base::_State_base> __state;
1722 if ((__policy & launch::async) == launch::async)
1726 __state = __future_base::_S_make_async_state(
1727 std::thread::__make_invoker(std::forward<_Fn>(__fn),
1728 std::forward<_Args>(__args)...)
1731 #if __cpp_exceptions
1732 catch(const system_error& __e)
1734 if (__e.code() != errc::resource_unavailable_try_again
1735 || (__policy & launch::deferred) != launch::deferred)
1742 __state = __future_base::_S_make_deferred_state(
1743 std::thread::__make_invoker(std::forward<_Fn>(__fn),
1744 std::forward<_Args>(__args)...));
1746 return future<__async_result_of<_Fn, _Args...>>(__state);
1749 /// async, potential overload
1750 template<typename _Fn, typename... _Args>
1751 _GLIBCXX_NODISCARD inline future<__async_result_of<_Fn, _Args...>>
1752 async(_Fn&& __fn, _Args&&... __args)
1754 return std::async(launch::async|launch::deferred,
1755 std::forward<_Fn>(__fn),
1756 std::forward<_Args>(__args)...);
1759 #endif // _GLIBCXX_ASYNC_ABI_COMPAT
1760 #endif // _GLIBCXX_HAS_GTHREADS
1763 _GLIBCXX_END_NAMESPACE_VERSION
1768 #endif // _GLIBCXX_FUTURE