1 // <future> -*- C++ -*-
3 // Copyright (C) 2009-2016 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>
41 #include <condition_variable>
42 #include <system_error>
44 #include <bits/atomic_futex.h>
45 #include <bits/functexcept.h>
46 #include <bits/unique_ptr.h>
47 #include <bits/shared_ptr.h>
48 #include <bits/uses_allocator.h>
49 #include <bits/allocated_ptr.h>
50 #include <ext/aligned_buffer.h>
52 namespace std _GLIBCXX_VISIBILITY(default)
54 _GLIBCXX_BEGIN_NAMESPACE_VERSION
57 * @defgroup futures Futures
58 * @ingroup concurrency
60 * Classes for futures support.
64 /// Error code for futures
65 enum class future_errc
67 future_already_retrieved = 1,
68 promise_already_satisfied,
75 struct is_error_code_enum<future_errc> : public true_type { };
77 /// Points to a statically-allocated object derived from error_category.
79 future_category() noexcept;
81 /// Overload for make_error_code.
83 make_error_code(future_errc __errc) noexcept
84 { return error_code(static_cast<int>(__errc), future_category()); }
86 /// Overload for make_error_condition.
87 inline error_condition
88 make_error_condition(future_errc __errc) noexcept
89 { return error_condition(static_cast<int>(__errc), future_category()); }
92 * @brief Exception type thrown by futures.
95 class future_error : public logic_error
100 explicit future_error(error_code __ec)
101 : logic_error("std::future_error: " + __ec.message()), _M_code(__ec)
104 virtual ~future_error() noexcept;
107 what() const noexcept;
110 code() const noexcept { return _M_code; }
113 // Forward declarations.
114 template<typename _Res>
117 template<typename _Res>
120 template<typename _Signature>
123 template<typename _Res>
126 /// Launch code for futures
133 constexpr launch operator&(launch __x, launch __y)
135 return static_cast<launch>(
136 static_cast<int>(__x) & static_cast<int>(__y));
139 constexpr launch operator|(launch __x, launch __y)
141 return static_cast<launch>(
142 static_cast<int>(__x) | static_cast<int>(__y));
145 constexpr launch operator^(launch __x, launch __y)
147 return static_cast<launch>(
148 static_cast<int>(__x) ^ static_cast<int>(__y));
151 constexpr launch operator~(launch __x)
152 { return static_cast<launch>(~static_cast<int>(__x)); }
154 inline launch& operator&=(launch& __x, launch __y)
155 { return __x = __x & __y; }
157 inline launch& operator|=(launch& __x, launch __y)
158 { return __x = __x | __y; }
160 inline launch& operator^=(launch& __x, launch __y)
161 { return __x = __x ^ __y; }
163 /// Status code for futures
164 enum class future_status
171 // _GLIBCXX_RESOLVE_LIB_DEFECTS
172 // 2021. Further incorrect usages of result_of
173 template<typename _Fn, typename... _Args>
174 using __async_result_of = typename result_of<
175 typename decay<_Fn>::type(typename decay<_Args>::type...)>::type;
177 template<typename _Fn, typename... _Args>
178 future<__async_result_of<_Fn, _Args...>>
179 async(launch __policy, _Fn&& __fn, _Args&&... __args);
181 template<typename _Fn, typename... _Args>
182 future<__async_result_of<_Fn, _Args...>>
183 async(_Fn&& __fn, _Args&&... __args);
185 #if defined(_GLIBCXX_HAS_GTHREADS) && defined(_GLIBCXX_USE_C99_STDINT_TR1) \
186 && (ATOMIC_INT_LOCK_FREE > 1)
188 /// Base class and enclosing scope.
191 /// Base class for results.
194 exception_ptr _M_error;
196 _Result_base(const _Result_base&) = delete;
197 _Result_base& operator=(const _Result_base&) = delete;
199 // _M_destroy() allows derived classes to control deallocation
200 virtual void _M_destroy() = 0;
204 void operator()(_Result_base* __fr) const { __fr->_M_destroy(); }
209 virtual ~_Result_base();
212 /// A unique_ptr for result objects.
213 template<typename _Res>
214 using _Ptr = unique_ptr<_Res, _Result_base::_Deleter>;
216 /// A result object that has storage for an object of type _Res.
217 template<typename _Res>
218 struct _Result : _Result_base
221 __gnu_cxx::__aligned_buffer<_Res> _M_storage;
225 typedef _Res result_type;
227 _Result() noexcept : _M_initialized() { }
235 // Return lvalue, future will add const or rvalue-reference
237 _M_value() noexcept { return *_M_storage._M_ptr(); }
240 _M_set(const _Res& __res)
242 ::new (_M_storage._M_addr()) _Res(__res);
243 _M_initialized = true;
249 ::new (_M_storage._M_addr()) _Res(std::move(__res));
250 _M_initialized = true;
254 void _M_destroy() { delete this; }
257 /// A result object that uses an allocator.
258 template<typename _Res, typename _Alloc>
259 struct _Result_alloc final : _Result<_Res>, _Alloc
261 using __allocator_type = __alloc_rebind<_Alloc, _Result_alloc>;
264 _Result_alloc(const _Alloc& __a) : _Result<_Res>(), _Alloc(__a)
270 __allocator_type __a(*this);
271 __allocated_ptr<__allocator_type> __guard_ptr{ __a, this };
272 this->~_Result_alloc();
276 // Create a result object that uses an allocator.
277 template<typename _Res, typename _Allocator>
278 static _Ptr<_Result_alloc<_Res, _Allocator>>
279 _S_allocate_result(const _Allocator& __a)
281 using __result_type = _Result_alloc<_Res, _Allocator>;
282 typename __result_type::__allocator_type __a2(__a);
283 auto __guard = std::__allocate_guarded(__a2);
284 __result_type* __p = ::new((void*)__guard.get()) __result_type{__a};
286 return _Ptr<__result_type>(__p);
289 // Keep it simple for std::allocator.
290 template<typename _Res, typename _Tp>
291 static _Ptr<_Result<_Res>>
292 _S_allocate_result(const std::allocator<_Tp>& __a)
294 return _Ptr<_Result<_Res>>(new _Result<_Res>);
297 // Base class for various types of shared state created by an
298 // asynchronous provider (such as a std::promise) and shared with one
299 // or more associated futures.
302 typedef _Ptr<_Result_base> _Ptr_type;
304 enum _Status : unsigned {
310 __atomic_futex_unsigned<> _M_status;
311 atomic_flag _M_retrieved = ATOMIC_FLAG_INIT;
315 _State_baseV2() noexcept : _M_result(), _M_status(_Status::__not_ready)
317 _State_baseV2(const _State_baseV2&) = delete;
318 _State_baseV2& operator=(const _State_baseV2&) = delete;
319 virtual ~_State_baseV2() = default;
324 // Run any deferred function or join any asynchronous thread:
326 // Acquire MO makes sure this synchronizes with the thread that made
328 _M_status._M_load_when_equal(_Status::__ready, memory_order_acquire);
332 template<typename _Rep, typename _Period>
334 wait_for(const chrono::duration<_Rep, _Period>& __rel)
336 // First, check if the future has been made ready. Use acquire MO
337 // to synchronize with the thread that made it ready.
338 if (_M_status._M_load(memory_order_acquire) == _Status::__ready)
339 return future_status::ready;
340 if (_M_is_deferred_future())
341 return future_status::deferred;
342 if (_M_status._M_load_when_equal_for(_Status::__ready,
343 memory_order_acquire, __rel))
345 // _GLIBCXX_RESOLVE_LIB_DEFECTS
346 // 2100. timed waiting functions must also join
347 // This call is a no-op by default except on an async future,
348 // in which case the async thread is joined. It's also not a
349 // no-op for a deferred future, but such a future will never
350 // reach this point because it returns future_status::deferred
351 // instead of waiting for the future to become ready (see
352 // above). Async futures synchronize in this call, so we need
353 // no further synchronization here.
356 return future_status::ready;
358 return future_status::timeout;
361 template<typename _Clock, typename _Duration>
363 wait_until(const chrono::time_point<_Clock, _Duration>& __abs)
365 // First, check if the future has been made ready. Use acquire MO
366 // to synchronize with the thread that made it ready.
367 if (_M_status._M_load(memory_order_acquire) == _Status::__ready)
368 return future_status::ready;
369 if (_M_is_deferred_future())
370 return future_status::deferred;
371 if (_M_status._M_load_when_equal_until(_Status::__ready,
372 memory_order_acquire, __abs))
374 // _GLIBCXX_RESOLVE_LIB_DEFECTS
375 // 2100. timed waiting functions must also join
376 // See wait_for(...) above.
379 return future_status::ready;
381 return future_status::timeout;
384 // Provide a result to the shared state and make it ready.
385 // Calls at most once: _M_result = __res();
387 _M_set_result(function<_Ptr_type()> __res, bool __ignore_failure = false)
389 bool __did_set = false;
390 // all calls to this function are serialized,
391 // side-effects of invoking __res only happen once
392 call_once(_M_once, &_State_baseV2::_M_do_set, this,
393 std::__addressof(__res), std::__addressof(__did_set));
395 // Use release MO to synchronize with observers of the ready state.
396 _M_status._M_store_notify_all(_Status::__ready,
397 memory_order_release);
398 else if (!__ignore_failure)
399 __throw_future_error(int(future_errc::promise_already_satisfied));
402 // Provide a result to the shared state but delay making it ready
403 // until the calling thread exits.
404 // Calls at most once: _M_result = __res();
406 _M_set_delayed_result(function<_Ptr_type()> __res,
407 weak_ptr<_State_baseV2> __self)
409 bool __did_set = false;
410 unique_ptr<_Make_ready> __mr{new _Make_ready};
411 // all calls to this function are serialized,
412 // side-effects of invoking __res only happen once
413 call_once(_M_once, &_State_baseV2::_M_do_set, this,
414 std::__addressof(__res), std::__addressof(__did_set));
416 __throw_future_error(int(future_errc::promise_already_satisfied));
417 __mr->_M_shared_state = std::move(__self);
422 // Abandon this shared state.
424 _M_break_promise(_Ptr_type __res)
426 if (static_cast<bool>(__res))
428 error_code __ec(make_error_code(future_errc::broken_promise));
429 __res->_M_error = make_exception_ptr(future_error(__ec));
430 // This function is only called when the last asynchronous result
431 // provider is abandoning this shared state, so noone can be
432 // trying to make the shared state ready at the same time, and
433 // we can access _M_result directly instead of through call_once.
434 _M_result.swap(__res);
435 // Use release MO to synchronize with observers of the ready state.
436 _M_status._M_store_notify_all(_Status::__ready,
437 memory_order_release);
441 // Called when this object is first passed to a future.
443 _M_set_retrieved_flag()
445 if (_M_retrieved.test_and_set())
446 __throw_future_error(int(future_errc::future_already_retrieved));
449 template<typename _Res, typename _Arg>
453 template<typename _Res, typename _Arg>
454 struct _Setter<_Res, _Arg&>
456 // check this is only used by promise<R>::set_value(const R&)
457 // or promise<R&>::set_value(R&)
458 static_assert(is_same<_Res, _Arg&>::value // promise<R&>
459 || is_same<const _Res, _Arg>::value, // promise<R>
460 "Invalid specialisation");
462 // Used by std::promise to copy construct the result.
463 typename promise<_Res>::_Ptr_type operator()() const
465 _State_baseV2::_S_check(_M_promise->_M_future);
466 _M_promise->_M_storage->_M_set(*_M_arg);
467 return std::move(_M_promise->_M_storage);
469 promise<_Res>* _M_promise;
474 template<typename _Res>
475 struct _Setter<_Res, _Res&&>
477 // Used by std::promise to move construct the result.
478 typename promise<_Res>::_Ptr_type operator()() const
480 _State_baseV2::_S_check(_M_promise->_M_future);
481 _M_promise->_M_storage->_M_set(std::move(*_M_arg));
482 return std::move(_M_promise->_M_storage);
484 promise<_Res>* _M_promise;
488 struct __exception_ptr_tag { };
491 template<typename _Res>
492 struct _Setter<_Res, __exception_ptr_tag>
494 // Used by std::promise to store an exception as the result.
495 typename promise<_Res>::_Ptr_type operator()() const
497 _State_baseV2::_S_check(_M_promise->_M_future);
498 _M_promise->_M_storage->_M_error = *_M_ex;
499 return std::move(_M_promise->_M_storage);
502 promise<_Res>* _M_promise;
503 exception_ptr* _M_ex;
506 template<typename _Res, typename _Arg>
507 static _Setter<_Res, _Arg&&>
508 __setter(promise<_Res>* __prom, _Arg&& __arg)
510 return _Setter<_Res, _Arg&&>{ __prom, std::__addressof(__arg) };
513 template<typename _Res>
514 static _Setter<_Res, __exception_ptr_tag>
515 __setter(exception_ptr& __ex, promise<_Res>* __prom)
517 return _Setter<_Res, __exception_ptr_tag>{ __prom, &__ex };
520 template<typename _Tp>
522 _S_check(const shared_ptr<_Tp>& __p)
524 if (!static_cast<bool>(__p))
525 __throw_future_error((int)future_errc::no_state);
529 // The function invoked with std::call_once(_M_once, ...).
531 _M_do_set(function<_Ptr_type()>* __f, bool* __did_set)
533 _Ptr_type __res = (*__f)();
534 // Notify the caller that we did try to set; if we do not throw an
535 // exception, the caller will be aware that it did set (e.g., see
538 _M_result.swap(__res); // nothrow
541 // Wait for completion of async function.
542 virtual void _M_complete_async() { }
544 // Return true if state corresponds to a deferred function.
545 virtual bool _M_is_deferred_future() const { return false; }
547 struct _Make_ready final : __at_thread_exit_elt
549 weak_ptr<_State_baseV2> _M_shared_state;
550 static void _S_run(void*);
555 #ifdef _GLIBCXX_ASYNC_ABI_COMPAT
557 class _Async_state_common;
559 using _State_base = _State_baseV2;
560 class _Async_state_commonV2;
563 template<typename _BoundFn, typename = typename _BoundFn::result_type>
564 class _Deferred_state;
566 template<typename _BoundFn, typename = typename _BoundFn::result_type>
567 class _Async_state_impl;
569 template<typename _Signature>
570 class _Task_state_base;
572 template<typename _Fn, typename _Alloc, typename _Signature>
575 template<typename _BoundFn>
576 static std::shared_ptr<_State_base>
577 _S_make_deferred_state(_BoundFn&& __fn);
579 template<typename _BoundFn>
580 static std::shared_ptr<_State_base>
581 _S_make_async_state(_BoundFn&& __fn);
583 template<typename _Res_ptr, typename _Fn,
584 typename _Res = typename _Res_ptr::element_type::result_type>
587 template<typename _Res_ptr, typename _BoundFn>
588 static _Task_setter<_Res_ptr, _BoundFn>
589 _S_task_setter(_Res_ptr& __ptr, _BoundFn& __call)
591 return { std::__addressof(__ptr), std::__addressof(__call) };
595 /// Partial specialization for reference types.
596 template<typename _Res>
597 struct __future_base::_Result<_Res&> : __future_base::_Result_base
599 typedef _Res& result_type;
601 _Result() noexcept : _M_value_ptr() { }
604 _M_set(_Res& __res) noexcept
605 { _M_value_ptr = std::addressof(__res); }
607 _Res& _M_get() noexcept { return *_M_value_ptr; }
612 void _M_destroy() { delete this; }
615 /// Explicit specialization for void.
617 struct __future_base::_Result<void> : __future_base::_Result_base
619 typedef void result_type;
622 void _M_destroy() { delete this; }
625 #ifndef _GLIBCXX_ASYNC_ABI_COMPAT
627 // Allow _Setter objects to be stored locally in std::function
628 template<typename _Res, typename _Arg>
629 struct __is_location_invariant
630 <__future_base::_State_base::_Setter<_Res, _Arg>>
633 // Allow _Task_setter objects to be stored locally in std::function
634 template<typename _Res_ptr, typename _Fn, typename _Res>
635 struct __is_location_invariant
636 <__future_base::_Task_setter<_Res_ptr, _Fn, _Res>>
639 /// Common implementation for future and shared_future.
640 template<typename _Res>
641 class __basic_future : public __future_base
644 typedef shared_ptr<_State_base> __state_type;
645 typedef __future_base::_Result<_Res>& __result_type;
648 __state_type _M_state;
652 __basic_future(const __basic_future&) = delete;
653 __basic_future& operator=(const __basic_future&) = delete;
656 valid() const noexcept { return static_cast<bool>(_M_state); }
661 _State_base::_S_check(_M_state);
665 template<typename _Rep, typename _Period>
667 wait_for(const chrono::duration<_Rep, _Period>& __rel) const
669 _State_base::_S_check(_M_state);
670 return _M_state->wait_for(__rel);
673 template<typename _Clock, typename _Duration>
675 wait_until(const chrono::time_point<_Clock, _Duration>& __abs) const
677 _State_base::_S_check(_M_state);
678 return _M_state->wait_until(__abs);
682 /// Wait for the state to be ready and rethrow any stored exception
684 _M_get_result() const
686 _State_base::_S_check(_M_state);
687 _Result_base& __res = _M_state->wait();
688 if (!(__res._M_error == 0))
689 rethrow_exception(__res._M_error);
690 return static_cast<__result_type>(__res);
693 void _M_swap(__basic_future& __that) noexcept
695 _M_state.swap(__that._M_state);
698 // Construction of a future by promise::get_future()
700 __basic_future(const __state_type& __state) : _M_state(__state)
702 _State_base::_S_check(_M_state);
703 _M_state->_M_set_retrieved_flag();
706 // Copy construction from a shared_future
708 __basic_future(const shared_future<_Res>&) noexcept;
710 // Move construction from a shared_future
712 __basic_future(shared_future<_Res>&&) noexcept;
714 // Move construction from a future
716 __basic_future(future<_Res>&&) noexcept;
718 constexpr __basic_future() noexcept : _M_state() { }
722 explicit _Reset(__basic_future& __fut) noexcept : _M_fut(__fut) { }
723 ~_Reset() { _M_fut._M_state.reset(); }
724 __basic_future& _M_fut;
729 /// Primary template for future.
730 template<typename _Res>
731 class future : public __basic_future<_Res>
733 friend class promise<_Res>;
734 template<typename> friend class packaged_task;
735 template<typename _Fn, typename... _Args>
736 friend future<__async_result_of<_Fn, _Args...>>
737 async(launch, _Fn&&, _Args&&...);
739 typedef __basic_future<_Res> _Base_type;
740 typedef typename _Base_type::__state_type __state_type;
743 future(const __state_type& __state) : _Base_type(__state) { }
746 constexpr future() noexcept : _Base_type() { }
749 future(future&& __uf) noexcept : _Base_type(std::move(__uf)) { }
752 future(const future&) = delete;
753 future& operator=(const future&) = delete;
755 future& operator=(future&& __fut) noexcept
757 future(std::move(__fut))._M_swap(*this);
761 /// Retrieving the value
765 typename _Base_type::_Reset __reset(*this);
766 return std::move(this->_M_get_result()._M_value());
769 shared_future<_Res> share();
772 /// Partial specialization for future<R&>
773 template<typename _Res>
774 class future<_Res&> : public __basic_future<_Res&>
776 friend class promise<_Res&>;
777 template<typename> friend class packaged_task;
778 template<typename _Fn, typename... _Args>
779 friend future<__async_result_of<_Fn, _Args...>>
780 async(launch, _Fn&&, _Args&&...);
782 typedef __basic_future<_Res&> _Base_type;
783 typedef typename _Base_type::__state_type __state_type;
786 future(const __state_type& __state) : _Base_type(__state) { }
789 constexpr future() noexcept : _Base_type() { }
792 future(future&& __uf) noexcept : _Base_type(std::move(__uf)) { }
795 future(const future&) = delete;
796 future& operator=(const future&) = delete;
798 future& operator=(future&& __fut) noexcept
800 future(std::move(__fut))._M_swap(*this);
804 /// Retrieving the value
808 typename _Base_type::_Reset __reset(*this);
809 return this->_M_get_result()._M_get();
812 shared_future<_Res&> share();
815 /// Explicit specialization for future<void>
817 class future<void> : public __basic_future<void>
819 friend class promise<void>;
820 template<typename> friend class packaged_task;
821 template<typename _Fn, typename... _Args>
822 friend future<__async_result_of<_Fn, _Args...>>
823 async(launch, _Fn&&, _Args&&...);
825 typedef __basic_future<void> _Base_type;
826 typedef typename _Base_type::__state_type __state_type;
829 future(const __state_type& __state) : _Base_type(__state) { }
832 constexpr future() noexcept : _Base_type() { }
835 future(future&& __uf) noexcept : _Base_type(std::move(__uf)) { }
838 future(const future&) = delete;
839 future& operator=(const future&) = delete;
841 future& operator=(future&& __fut) noexcept
843 future(std::move(__fut))._M_swap(*this);
847 /// Retrieving the value
851 typename _Base_type::_Reset __reset(*this);
852 this->_M_get_result();
855 shared_future<void> share();
859 /// Primary template for shared_future.
860 template<typename _Res>
861 class shared_future : public __basic_future<_Res>
863 typedef __basic_future<_Res> _Base_type;
866 constexpr shared_future() noexcept : _Base_type() { }
869 shared_future(const shared_future& __sf) : _Base_type(__sf) { }
871 /// Construct from a future rvalue
872 shared_future(future<_Res>&& __uf) noexcept
873 : _Base_type(std::move(__uf))
876 /// Construct from a shared_future rvalue
877 shared_future(shared_future&& __sf) noexcept
878 : _Base_type(std::move(__sf))
881 shared_future& operator=(const shared_future& __sf)
883 shared_future(__sf)._M_swap(*this);
887 shared_future& operator=(shared_future&& __sf) noexcept
889 shared_future(std::move(__sf))._M_swap(*this);
893 /// Retrieving the value
895 get() const { return this->_M_get_result()._M_value(); }
898 /// Partial specialization for shared_future<R&>
899 template<typename _Res>
900 class shared_future<_Res&> : public __basic_future<_Res&>
902 typedef __basic_future<_Res&> _Base_type;
905 constexpr shared_future() noexcept : _Base_type() { }
908 shared_future(const shared_future& __sf) : _Base_type(__sf) { }
910 /// Construct from a future rvalue
911 shared_future(future<_Res&>&& __uf) noexcept
912 : _Base_type(std::move(__uf))
915 /// Construct from a shared_future rvalue
916 shared_future(shared_future&& __sf) noexcept
917 : _Base_type(std::move(__sf))
920 shared_future& operator=(const shared_future& __sf)
922 shared_future(__sf)._M_swap(*this);
926 shared_future& operator=(shared_future&& __sf) noexcept
928 shared_future(std::move(__sf))._M_swap(*this);
932 /// Retrieving the value
934 get() const { return this->_M_get_result()._M_get(); }
937 /// Explicit specialization for shared_future<void>
939 class shared_future<void> : public __basic_future<void>
941 typedef __basic_future<void> _Base_type;
944 constexpr shared_future() noexcept : _Base_type() { }
947 shared_future(const shared_future& __sf) : _Base_type(__sf) { }
949 /// Construct from a future rvalue
950 shared_future(future<void>&& __uf) noexcept
951 : _Base_type(std::move(__uf))
954 /// Construct from a shared_future rvalue
955 shared_future(shared_future&& __sf) noexcept
956 : _Base_type(std::move(__sf))
959 shared_future& operator=(const shared_future& __sf)
961 shared_future(__sf)._M_swap(*this);
965 shared_future& operator=(shared_future&& __sf) noexcept
967 shared_future(std::move(__sf))._M_swap(*this);
971 // Retrieving the value
973 get() const { this->_M_get_result(); }
976 // Now we can define the protected __basic_future constructors.
977 template<typename _Res>
978 inline __basic_future<_Res>::
979 __basic_future(const shared_future<_Res>& __sf) noexcept
980 : _M_state(__sf._M_state)
983 template<typename _Res>
984 inline __basic_future<_Res>::
985 __basic_future(shared_future<_Res>&& __sf) noexcept
986 : _M_state(std::move(__sf._M_state))
989 template<typename _Res>
990 inline __basic_future<_Res>::
991 __basic_future(future<_Res>&& __uf) noexcept
992 : _M_state(std::move(__uf._M_state))
995 template<typename _Res>
996 inline shared_future<_Res>
997 future<_Res>::share()
998 { return shared_future<_Res>(std::move(*this)); }
1000 template<typename _Res>
1001 inline shared_future<_Res&>
1002 future<_Res&>::share()
1003 { return shared_future<_Res&>(std::move(*this)); }
1005 inline shared_future<void>
1006 future<void>::share()
1007 { return shared_future<void>(std::move(*this)); }
1009 /// Primary template for promise
1010 template<typename _Res>
1013 typedef __future_base::_State_base _State;
1014 typedef __future_base::_Result<_Res> _Res_type;
1015 typedef __future_base::_Ptr<_Res_type> _Ptr_type;
1016 template<typename, typename> friend class _State::_Setter;
1018 shared_ptr<_State> _M_future;
1019 _Ptr_type _M_storage;
1023 : _M_future(std::make_shared<_State>()),
1024 _M_storage(new _Res_type())
1027 promise(promise&& __rhs) noexcept
1028 : _M_future(std::move(__rhs._M_future)),
1029 _M_storage(std::move(__rhs._M_storage))
1032 template<typename _Allocator>
1033 promise(allocator_arg_t, const _Allocator& __a)
1034 : _M_future(std::allocate_shared<_State>(__a)),
1035 _M_storage(__future_base::_S_allocate_result<_Res>(__a))
1038 template<typename _Allocator>
1039 promise(allocator_arg_t, const _Allocator&, promise&& __rhs)
1040 : _M_future(std::move(__rhs._M_future)),
1041 _M_storage(std::move(__rhs._M_storage))
1044 promise(const promise&) = delete;
1048 if (static_cast<bool>(_M_future) && !_M_future.unique())
1049 _M_future->_M_break_promise(std::move(_M_storage));
1054 operator=(promise&& __rhs) noexcept
1056 promise(std::move(__rhs)).swap(*this);
1060 promise& operator=(const promise&) = delete;
1063 swap(promise& __rhs) noexcept
1065 _M_future.swap(__rhs._M_future);
1066 _M_storage.swap(__rhs._M_storage);
1069 // Retrieving the result
1072 { return future<_Res>(_M_future); }
1074 // Setting the result
1076 set_value(const _Res& __r)
1077 { _M_future->_M_set_result(_State::__setter(this, __r)); }
1080 set_value(_Res&& __r)
1081 { _M_future->_M_set_result(_State::__setter(this, std::move(__r))); }
1084 set_exception(exception_ptr __p)
1085 { _M_future->_M_set_result(_State::__setter(__p, this)); }
1088 set_value_at_thread_exit(const _Res& __r)
1090 _M_future->_M_set_delayed_result(_State::__setter(this, __r),
1095 set_value_at_thread_exit(_Res&& __r)
1097 _M_future->_M_set_delayed_result(
1098 _State::__setter(this, std::move(__r)), _M_future);
1102 set_exception_at_thread_exit(exception_ptr __p)
1104 _M_future->_M_set_delayed_result(_State::__setter(__p, this),
1109 template<typename _Res>
1111 swap(promise<_Res>& __x, promise<_Res>& __y) noexcept
1114 template<typename _Res, typename _Alloc>
1115 struct uses_allocator<promise<_Res>, _Alloc>
1116 : public true_type { };
1119 /// Partial specialization for promise<R&>
1120 template<typename _Res>
1121 class promise<_Res&>
1123 typedef __future_base::_State_base _State;
1124 typedef __future_base::_Result<_Res&> _Res_type;
1125 typedef __future_base::_Ptr<_Res_type> _Ptr_type;
1126 template<typename, typename> friend class _State::_Setter;
1128 shared_ptr<_State> _M_future;
1129 _Ptr_type _M_storage;
1133 : _M_future(std::make_shared<_State>()),
1134 _M_storage(new _Res_type())
1137 promise(promise&& __rhs) noexcept
1138 : _M_future(std::move(__rhs._M_future)),
1139 _M_storage(std::move(__rhs._M_storage))
1142 template<typename _Allocator>
1143 promise(allocator_arg_t, const _Allocator& __a)
1144 : _M_future(std::allocate_shared<_State>(__a)),
1145 _M_storage(__future_base::_S_allocate_result<_Res&>(__a))
1148 template<typename _Allocator>
1149 promise(allocator_arg_t, const _Allocator&, promise&& __rhs)
1150 : _M_future(std::move(__rhs._M_future)),
1151 _M_storage(std::move(__rhs._M_storage))
1154 promise(const promise&) = delete;
1158 if (static_cast<bool>(_M_future) && !_M_future.unique())
1159 _M_future->_M_break_promise(std::move(_M_storage));
1164 operator=(promise&& __rhs) noexcept
1166 promise(std::move(__rhs)).swap(*this);
1170 promise& operator=(const promise&) = delete;
1173 swap(promise& __rhs) noexcept
1175 _M_future.swap(__rhs._M_future);
1176 _M_storage.swap(__rhs._M_storage);
1179 // Retrieving the result
1182 { return future<_Res&>(_M_future); }
1184 // Setting the result
1186 set_value(_Res& __r)
1187 { _M_future->_M_set_result(_State::__setter(this, __r)); }
1190 set_exception(exception_ptr __p)
1191 { _M_future->_M_set_result(_State::__setter(__p, this)); }
1194 set_value_at_thread_exit(_Res& __r)
1196 _M_future->_M_set_delayed_result(_State::__setter(this, __r),
1201 set_exception_at_thread_exit(exception_ptr __p)
1203 _M_future->_M_set_delayed_result(_State::__setter(__p, this),
1208 /// Explicit specialization for promise<void>
1212 typedef __future_base::_State_base _State;
1213 typedef __future_base::_Result<void> _Res_type;
1214 typedef __future_base::_Ptr<_Res_type> _Ptr_type;
1215 template<typename, typename> friend class _State::_Setter;
1217 shared_ptr<_State> _M_future;
1218 _Ptr_type _M_storage;
1222 : _M_future(std::make_shared<_State>()),
1223 _M_storage(new _Res_type())
1226 promise(promise&& __rhs) noexcept
1227 : _M_future(std::move(__rhs._M_future)),
1228 _M_storage(std::move(__rhs._M_storage))
1231 template<typename _Allocator>
1232 promise(allocator_arg_t, const _Allocator& __a)
1233 : _M_future(std::allocate_shared<_State>(__a)),
1234 _M_storage(__future_base::_S_allocate_result<void>(__a))
1237 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1238 // 2095. missing constructors needed for uses-allocator construction
1239 template<typename _Allocator>
1240 promise(allocator_arg_t, const _Allocator&, promise&& __rhs)
1241 : _M_future(std::move(__rhs._M_future)),
1242 _M_storage(std::move(__rhs._M_storage))
1245 promise(const promise&) = delete;
1249 if (static_cast<bool>(_M_future) && !_M_future.unique())
1250 _M_future->_M_break_promise(std::move(_M_storage));
1255 operator=(promise&& __rhs) noexcept
1257 promise(std::move(__rhs)).swap(*this);
1261 promise& operator=(const promise&) = delete;
1264 swap(promise& __rhs) noexcept
1266 _M_future.swap(__rhs._M_future);
1267 _M_storage.swap(__rhs._M_storage);
1270 // Retrieving the result
1273 { return future<void>(_M_future); }
1275 // Setting the result
1279 set_exception(exception_ptr __p)
1280 { _M_future->_M_set_result(_State::__setter(__p, this)); }
1283 set_value_at_thread_exit();
1286 set_exception_at_thread_exit(exception_ptr __p)
1288 _M_future->_M_set_delayed_result(_State::__setter(__p, this),
1295 struct __future_base::_State_base::_Setter<void, void>
1297 promise<void>::_Ptr_type operator()() const
1299 _State_base::_S_check(_M_promise->_M_future);
1300 return std::move(_M_promise->_M_storage);
1303 promise<void>* _M_promise;
1307 promise<void>::set_value()
1308 { _M_future->_M_set_result(_State::_Setter<void, void>{ this }); }
1311 promise<void>::set_value_at_thread_exit()
1313 _M_future->_M_set_delayed_result(_State::_Setter<void, void>{this},
1317 template<typename _Ptr_type, typename _Fn, typename _Res>
1318 struct __future_base::_Task_setter
1320 // Invoke the function and provide the result to the caller.
1321 _Ptr_type operator()() const
1325 (*_M_result)->_M_set((*_M_fn)());
1327 __catch(const __cxxabiv1::__forced_unwind&)
1329 __throw_exception_again; // will cause broken_promise
1333 (*_M_result)->_M_error = current_exception();
1335 return std::move(*_M_result);
1337 _Ptr_type* _M_result;
1341 template<typename _Ptr_type, typename _Fn>
1342 struct __future_base::_Task_setter<_Ptr_type, _Fn, void>
1344 _Ptr_type operator()() const
1350 __catch(const __cxxabiv1::__forced_unwind&)
1352 __throw_exception_again; // will cause broken_promise
1356 (*_M_result)->_M_error = current_exception();
1358 return std::move(*_M_result);
1360 _Ptr_type* _M_result;
1364 // Holds storage for a packaged_task's result.
1365 template<typename _Res, typename... _Args>
1366 struct __future_base::_Task_state_base<_Res(_Args...)>
1367 : __future_base::_State_base
1369 typedef _Res _Res_type;
1371 template<typename _Alloc>
1372 _Task_state_base(const _Alloc& __a)
1373 : _M_result(_S_allocate_result<_Res>(__a))
1376 // Invoke the stored task and make the state ready.
1378 _M_run(_Args&&... __args) = 0;
1380 // Invoke the stored task and make the state ready at thread exit.
1382 _M_run_delayed(_Args&&... __args, weak_ptr<_State_base>) = 0;
1384 virtual shared_ptr<_Task_state_base>
1387 typedef __future_base::_Ptr<_Result<_Res>> _Ptr_type;
1388 _Ptr_type _M_result;
1391 // Holds a packaged_task's stored task.
1392 template<typename _Fn, typename _Alloc, typename _Res, typename... _Args>
1393 struct __future_base::_Task_state<_Fn, _Alloc, _Res(_Args...)> final
1394 : __future_base::_Task_state_base<_Res(_Args...)>
1396 template<typename _Fn2>
1397 _Task_state(_Fn2&& __fn, const _Alloc& __a)
1398 : _Task_state_base<_Res(_Args...)>(__a),
1399 _M_impl(std::forward<_Fn2>(__fn), __a)
1404 _M_run(_Args&&... __args)
1406 // bound arguments decay so wrap lvalue references
1407 auto __boundfn = std::__bind_simple(std::ref(_M_impl._M_fn),
1408 _S_maybe_wrap_ref(std::forward<_Args>(__args))...);
1409 this->_M_set_result(_S_task_setter(this->_M_result, __boundfn));
1413 _M_run_delayed(_Args&&... __args, weak_ptr<_State_base> __self)
1415 // bound arguments decay so wrap lvalue references
1416 auto __boundfn = std::__bind_simple(std::ref(_M_impl._M_fn),
1417 _S_maybe_wrap_ref(std::forward<_Args>(__args))...);
1418 this->_M_set_delayed_result(_S_task_setter(this->_M_result, __boundfn),
1422 virtual shared_ptr<_Task_state_base<_Res(_Args...)>>
1425 template<typename _Tp>
1426 static reference_wrapper<_Tp>
1427 _S_maybe_wrap_ref(_Tp& __t)
1428 { return std::ref(__t); }
1430 template<typename _Tp>
1432 typename enable_if<!is_lvalue_reference<_Tp>::value, _Tp>::type&&
1433 _S_maybe_wrap_ref(_Tp&& __t)
1434 { return std::forward<_Tp>(__t); }
1436 struct _Impl : _Alloc
1438 template<typename _Fn2>
1439 _Impl(_Fn2&& __fn, const _Alloc& __a)
1440 : _Alloc(__a), _M_fn(std::forward<_Fn2>(__fn)) { }
1445 template<typename _Signature, typename _Fn, typename _Alloc>
1446 static shared_ptr<__future_base::_Task_state_base<_Signature>>
1447 __create_task_state(_Fn&& __fn, const _Alloc& __a)
1449 typedef typename decay<_Fn>::type _Fn2;
1450 typedef __future_base::_Task_state<_Fn2, _Alloc, _Signature> _State;
1451 return std::allocate_shared<_State>(__a, std::forward<_Fn>(__fn), __a);
1454 template<typename _Fn, typename _Alloc, typename _Res, typename... _Args>
1455 shared_ptr<__future_base::_Task_state_base<_Res(_Args...)>>
1456 __future_base::_Task_state<_Fn, _Alloc, _Res(_Args...)>::_M_reset()
1458 return __create_task_state<_Res(_Args...)>(std::move(_M_impl._M_fn),
1459 static_cast<_Alloc&>(_M_impl));
1462 template<typename _Task, typename _Fn, bool
1463 = is_same<_Task, typename decay<_Fn>::type>::value>
1464 struct __constrain_pkgdtask
1465 { typedef void __type; };
1467 template<typename _Task, typename _Fn>
1468 struct __constrain_pkgdtask<_Task, _Fn, true>
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;
1479 // Construction and destruction
1480 packaged_task() noexcept { }
1482 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1483 // 2095. missing constructors needed for uses-allocator construction
1484 template<typename _Allocator>
1485 packaged_task(allocator_arg_t, const _Allocator& __a) noexcept
1488 template<typename _Fn, typename = typename
1489 __constrain_pkgdtask<packaged_task, _Fn>::__type>
1491 packaged_task(_Fn&& __fn)
1492 : packaged_task(allocator_arg, std::allocator<int>(),
1493 std::forward<_Fn>(__fn))
1496 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1497 // 2097. packaged_task constructors should be constrained
1498 // 2407. [this constructor should not be] explicit
1499 template<typename _Fn, typename _Alloc, typename = typename
1500 __constrain_pkgdtask<packaged_task, _Fn>::__type>
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))
1508 if (static_cast<bool>(_M_state) && !_M_state.unique())
1509 _M_state->_M_break_promise(std::move(_M_state->_M_result));
1513 packaged_task(const packaged_task&) = delete;
1514 packaged_task& operator=(const packaged_task&) = delete;
1516 template<typename _Allocator>
1517 packaged_task(allocator_arg_t, const _Allocator&,
1518 const packaged_task&) = delete;
1521 packaged_task(packaged_task&& __other) noexcept
1522 { this->swap(__other); }
1524 template<typename _Allocator>
1525 packaged_task(allocator_arg_t, const _Allocator&,
1526 packaged_task&& __other) noexcept
1527 { this->swap(__other); }
1529 packaged_task& operator=(packaged_task&& __other) noexcept
1531 packaged_task(std::move(__other)).swap(*this);
1536 swap(packaged_task& __other) noexcept
1537 { _M_state.swap(__other._M_state); }
1540 valid() const noexcept
1541 { return static_cast<bool>(_M_state); }
1546 { return future<_Res>(_M_state); }
1550 operator()(_ArgTypes... __args)
1552 __future_base::_State_base::_S_check(_M_state);
1553 _M_state->_M_run(std::forward<_ArgTypes>(__args)...);
1557 make_ready_at_thread_exit(_ArgTypes... __args)
1559 __future_base::_State_base::_S_check(_M_state);
1560 _M_state->_M_run_delayed(std::forward<_ArgTypes>(__args)..., _M_state);
1566 __future_base::_State_base::_S_check(_M_state);
1567 packaged_task __tmp;
1568 __tmp._M_state = _M_state;
1569 _M_state = _M_state->_M_reset();
1574 template<typename _Res, typename... _ArgTypes>
1576 swap(packaged_task<_Res(_ArgTypes...)>& __x,
1577 packaged_task<_Res(_ArgTypes...)>& __y) noexcept
1580 template<typename _Res, typename _Alloc>
1581 struct uses_allocator<packaged_task<_Res>, _Alloc>
1582 : public true_type { };
1585 // Shared state created by std::async().
1586 // Holds a deferred function and storage for its result.
1587 template<typename _BoundFn, typename _Res>
1588 class __future_base::_Deferred_state final
1589 : public __future_base::_State_base
1593 _Deferred_state(_BoundFn&& __fn)
1594 : _M_result(new _Result<_Res>()), _M_fn(std::move(__fn))
1598 typedef __future_base::_Ptr<_Result<_Res>> _Ptr_type;
1599 _Ptr_type _M_result;
1602 // Run the deferred function.
1606 // Multiple threads can call a waiting function on the future and
1607 // reach this point at the same time. The call_once in _M_set_result
1608 // ensures only the first one run the deferred function, stores the
1609 // result in _M_result, swaps that with the base _M_result and makes
1610 // the state ready. Tell _M_set_result to ignore failure so all later
1611 // calls do nothing.
1612 _M_set_result(_S_task_setter(_M_result, _M_fn), true);
1615 // Caller should check whether the state is ready first, because this
1616 // function will return true even after the deferred function has run.
1617 virtual bool _M_is_deferred_future() const { return true; }
1620 // Common functionality hoisted out of the _Async_state_impl template.
1621 class __future_base::_Async_state_commonV2
1622 : public __future_base::_State_base
1625 ~_Async_state_commonV2() = default;
1627 // Make waiting functions block until the thread completes, as if joined.
1629 // This function is used by wait() to satisfy the first requirement below
1630 // and by wait_for() / wait_until() to satisfy the second.
1634 // — a call to a waiting function on an asynchronous return object that
1635 // shares the shared state created by this async call shall block until
1636 // the associated thread has completed, as if joined, or else time out.
1638 // — the associated thread completion synchronizes with the return from
1639 // the first function that successfully detects the ready status of the
1640 // shared state or with the return from the last function that releases
1641 // the shared state, whichever happens first.
1642 virtual void _M_complete_async() { _M_join(); }
1644 void _M_join() { std::call_once(_M_once, &thread::join, &_M_thread); }
1650 // Shared state created by std::async().
1651 // Starts a new thread that runs a function and makes the shared state ready.
1652 template<typename _BoundFn, typename _Res>
1653 class __future_base::_Async_state_impl final
1654 : public __future_base::_Async_state_commonV2
1658 _Async_state_impl(_BoundFn&& __fn)
1659 : _M_result(new _Result<_Res>()), _M_fn(std::move(__fn))
1661 _M_thread = std::thread{ [this] {
1664 _M_set_result(_S_task_setter(_M_result, _M_fn));
1666 __catch (const __cxxabiv1::__forced_unwind&)
1668 // make the shared state ready on thread cancellation
1669 if (static_cast<bool>(_M_result))
1670 this->_M_break_promise(std::move(_M_result));
1671 __throw_exception_again;
1676 // Must not destroy _M_result and _M_fn until the thread finishes.
1677 // Call join() directly rather than through _M_join() because no other
1678 // thread can be referring to this state if it is being destroyed.
1679 ~_Async_state_impl() { if (_M_thread.joinable()) _M_thread.join(); }
1682 typedef __future_base::_Ptr<_Result<_Res>> _Ptr_type;
1683 _Ptr_type _M_result;
1687 template<typename _BoundFn>
1688 inline std::shared_ptr<__future_base::_State_base>
1689 __future_base::_S_make_deferred_state(_BoundFn&& __fn)
1691 typedef typename remove_reference<_BoundFn>::type __fn_type;
1692 typedef _Deferred_state<__fn_type> __state_type;
1693 return std::make_shared<__state_type>(std::move(__fn));
1696 template<typename _BoundFn>
1697 inline std::shared_ptr<__future_base::_State_base>
1698 __future_base::_S_make_async_state(_BoundFn&& __fn)
1700 typedef typename remove_reference<_BoundFn>::type __fn_type;
1701 typedef _Async_state_impl<__fn_type> __state_type;
1702 return std::make_shared<__state_type>(std::move(__fn));
1707 template<typename _Fn, typename... _Args>
1708 future<__async_result_of<_Fn, _Args...>>
1709 async(launch __policy, _Fn&& __fn, _Args&&... __args)
1711 std::shared_ptr<__future_base::_State_base> __state;
1712 if ((__policy & launch::async) == launch::async)
1716 __state = __future_base::_S_make_async_state(std::__bind_simple(
1717 std::forward<_Fn>(__fn), std::forward<_Args>(__args)...));
1719 #if __cpp_exceptions
1720 catch(const system_error& __e)
1722 if (__e.code() != errc::resource_unavailable_try_again
1723 || (__policy & launch::deferred) != launch::deferred)
1730 __state = __future_base::_S_make_deferred_state(std::__bind_simple(
1731 std::forward<_Fn>(__fn), std::forward<_Args>(__args)...));
1733 return future<__async_result_of<_Fn, _Args...>>(__state);
1736 /// async, potential overload
1737 template<typename _Fn, typename... _Args>
1738 inline future<__async_result_of<_Fn, _Args...>>
1739 async(_Fn&& __fn, _Args&&... __args)
1741 return std::async(launch::async|launch::deferred,
1742 std::forward<_Fn>(__fn),
1743 std::forward<_Args>(__args)...);
1746 #endif // _GLIBCXX_ASYNC_ABI_COMPAT
1747 #endif // _GLIBCXX_HAS_GTHREADS && _GLIBCXX_USE_C99_STDINT_TR1
1748 // && ATOMIC_INT_LOCK_FREE
1751 _GLIBCXX_END_NAMESPACE_VERSION
1756 #endif // _GLIBCXX_FUTURE