1 // <future> -*- C++ -*-
3 // Copyright (C) 2009-2015 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 template<typename _Fn, typename... _Args>
172 future<typename result_of<_Fn(_Args...)>::type>
173 async(launch __policy, _Fn&& __fn, _Args&&... __args);
175 template<typename _Fn, typename... _Args>
176 future<typename result_of<_Fn(_Args...)>::type>
177 async(_Fn&& __fn, _Args&&... __args);
179 #if defined(_GLIBCXX_HAS_GTHREADS) && defined(_GLIBCXX_USE_C99_STDINT_TR1) \
180 && (ATOMIC_INT_LOCK_FREE > 1)
182 /// Base class and enclosing scope.
185 /// Base class for results.
188 exception_ptr _M_error;
190 _Result_base(const _Result_base&) = delete;
191 _Result_base& operator=(const _Result_base&) = delete;
193 // _M_destroy() allows derived classes to control deallocation
194 virtual void _M_destroy() = 0;
198 void operator()(_Result_base* __fr) const { __fr->_M_destroy(); }
203 virtual ~_Result_base();
206 /// A unique_ptr for result objects.
207 template<typename _Res>
208 using _Ptr = unique_ptr<_Res, _Result_base::_Deleter>;
210 /// A result object that has storage for an object of type _Res.
211 template<typename _Res>
212 struct _Result : _Result_base
215 __gnu_cxx::__aligned_buffer<_Res> _M_storage;
219 typedef _Res result_type;
221 _Result() noexcept : _M_initialized() { }
229 // Return lvalue, future will add const or rvalue-reference
231 _M_value() noexcept { return *_M_storage._M_ptr(); }
234 _M_set(const _Res& __res)
236 ::new (_M_storage._M_addr()) _Res(__res);
237 _M_initialized = true;
243 ::new (_M_storage._M_addr()) _Res(std::move(__res));
244 _M_initialized = true;
248 void _M_destroy() { delete this; }
251 /// A result object that uses an allocator.
252 template<typename _Res, typename _Alloc>
253 struct _Result_alloc final : _Result<_Res>, _Alloc
255 using __allocator_type = __alloc_rebind<_Alloc, _Result_alloc>;
258 _Result_alloc(const _Alloc& __a) : _Result<_Res>(), _Alloc(__a)
264 __allocator_type __a(*this);
265 __allocated_ptr<__allocator_type> __guard_ptr{ __a, this };
266 this->~_Result_alloc();
270 // Create a result object that uses an allocator.
271 template<typename _Res, typename _Allocator>
272 static _Ptr<_Result_alloc<_Res, _Allocator>>
273 _S_allocate_result(const _Allocator& __a)
275 using __result_type = _Result_alloc<_Res, _Allocator>;
276 typename __result_type::__allocator_type __a2(__a);
277 auto __guard = std::__allocate_guarded(__a2);
278 __result_type* __p = ::new((void*)__guard.get()) __result_type{__a};
280 return _Ptr<__result_type>(__p);
283 // Keep it simple for std::allocator.
284 template<typename _Res, typename _Tp>
285 static _Ptr<_Result<_Res>>
286 _S_allocate_result(const std::allocator<_Tp>& __a)
288 return _Ptr<_Result<_Res>>(new _Result<_Res>);
291 // Base class for various types of shared state created by an
292 // asynchronous provider (such as a std::promise) and shared with one
293 // or more associated futures.
296 typedef _Ptr<_Result_base> _Ptr_type;
298 enum _Status : unsigned {
304 __atomic_futex_unsigned<> _M_status;
305 atomic_flag _M_retrieved = ATOMIC_FLAG_INIT;
309 _State_baseV2() noexcept : _M_result(), _M_status(_Status::__not_ready)
311 _State_baseV2(const _State_baseV2&) = delete;
312 _State_baseV2& operator=(const _State_baseV2&) = delete;
313 virtual ~_State_baseV2() = default;
318 // Run any deferred function or join any asynchronous thread:
320 // Acquire MO makes sure this synchronizes with the thread that made
322 _M_status._M_load_when_equal(_Status::__ready, memory_order_acquire);
326 template<typename _Rep, typename _Period>
328 wait_for(const chrono::duration<_Rep, _Period>& __rel)
330 // First, check if the future has been made ready. Use acquire MO
331 // to synchronize with the thread that made it ready.
332 if (_M_status._M_load(memory_order_acquire) == _Status::__ready)
333 return future_status::ready;
334 if (_M_is_deferred_future())
335 return future_status::deferred;
336 if (_M_status._M_load_when_equal_for(_Status::__ready,
337 memory_order_acquire, __rel))
339 // _GLIBCXX_RESOLVE_LIB_DEFECTS
340 // 2100. timed waiting functions must also join
341 // This call is a no-op by default except on an async future,
342 // in which case the async thread is joined. It's also not a
343 // no-op for a deferred future, but such a future will never
344 // reach this point because it returns future_status::deferred
345 // instead of waiting for the future to become ready (see
346 // above). Async futures synchronize in this call, so we need
347 // no further synchronization here.
350 return future_status::ready;
352 return future_status::timeout;
355 template<typename _Clock, typename _Duration>
357 wait_until(const chrono::time_point<_Clock, _Duration>& __abs)
359 // First, check if the future has been made ready. Use acquire MO
360 // to synchronize with the thread that made it ready.
361 if (_M_status._M_load(memory_order_acquire) == _Status::__ready)
362 return future_status::ready;
363 if (_M_is_deferred_future())
364 return future_status::deferred;
365 if (_M_status._M_load_when_equal_until(_Status::__ready,
366 memory_order_acquire, __abs))
368 // _GLIBCXX_RESOLVE_LIB_DEFECTS
369 // 2100. timed waiting functions must also join
370 // See wait_for(...) above.
373 return future_status::ready;
375 return future_status::timeout;
378 // Provide a result to the shared state and make it ready.
379 // Calls at most once: _M_result = __res();
381 _M_set_result(function<_Ptr_type()> __res, bool __ignore_failure = false)
383 bool __did_set = false;
384 // all calls to this function are serialized,
385 // side-effects of invoking __res only happen once
386 call_once(_M_once, &_State_baseV2::_M_do_set, this,
387 std::__addressof(__res), std::__addressof(__did_set));
389 // Use release MO to synchronize with observers of the ready state.
390 _M_status._M_store_notify_all(_Status::__ready,
391 memory_order_release);
392 else if (!__ignore_failure)
393 __throw_future_error(int(future_errc::promise_already_satisfied));
396 // Provide a result to the shared state but delay making it ready
397 // until the calling thread exits.
398 // Calls at most once: _M_result = __res();
400 _M_set_delayed_result(function<_Ptr_type()> __res,
401 weak_ptr<_State_baseV2> __self)
403 bool __did_set = false;
404 unique_ptr<_Make_ready> __mr{new _Make_ready};
405 // all calls to this function are serialized,
406 // side-effects of invoking __res only happen once
407 call_once(_M_once, &_State_baseV2::_M_do_set, this,
408 std::__addressof(__res), std::__addressof(__did_set));
410 __throw_future_error(int(future_errc::promise_already_satisfied));
411 __mr->_M_shared_state = std::move(__self);
416 // Abandon this shared state.
418 _M_break_promise(_Ptr_type __res)
420 if (static_cast<bool>(__res))
422 error_code __ec(make_error_code(future_errc::broken_promise));
423 __res->_M_error = make_exception_ptr(future_error(__ec));
424 // This function is only called when the last asynchronous result
425 // provider is abandoning this shared state, so noone can be
426 // trying to make the shared state ready at the same time, and
427 // we can access _M_result directly instead of through call_once.
428 _M_result.swap(__res);
429 // Use release MO to synchronize with observers of the ready state.
430 _M_status._M_store_notify_all(_Status::__ready,
431 memory_order_release);
435 // Called when this object is first passed to a future.
437 _M_set_retrieved_flag()
439 if (_M_retrieved.test_and_set())
440 __throw_future_error(int(future_errc::future_already_retrieved));
443 template<typename _Res, typename _Arg>
447 template<typename _Res, typename _Arg>
448 struct _Setter<_Res, _Arg&>
450 // check this is only used by promise<R>::set_value(const R&)
451 // or promise<R&>::set_value(R&)
452 static_assert(is_same<_Res, _Arg&>::value // promise<R&>
453 || is_same<const _Res, _Arg>::value, // promise<R>
454 "Invalid specialisation");
456 // Used by std::promise to copy construct the result.
457 typename promise<_Res>::_Ptr_type operator()() const
459 _State_baseV2::_S_check(_M_promise->_M_future);
460 _M_promise->_M_storage->_M_set(*_M_arg);
461 return std::move(_M_promise->_M_storage);
463 promise<_Res>* _M_promise;
468 template<typename _Res>
469 struct _Setter<_Res, _Res&&>
471 // Used by std::promise to move construct the result.
472 typename promise<_Res>::_Ptr_type operator()() const
474 _State_baseV2::_S_check(_M_promise->_M_future);
475 _M_promise->_M_storage->_M_set(std::move(*_M_arg));
476 return std::move(_M_promise->_M_storage);
478 promise<_Res>* _M_promise;
482 struct __exception_ptr_tag { };
485 template<typename _Res>
486 struct _Setter<_Res, __exception_ptr_tag>
488 // Used by std::promise to store an exception as the result.
489 typename promise<_Res>::_Ptr_type operator()() const
491 _State_baseV2::_S_check(_M_promise->_M_future);
492 _M_promise->_M_storage->_M_error = *_M_ex;
493 return std::move(_M_promise->_M_storage);
496 promise<_Res>* _M_promise;
497 exception_ptr* _M_ex;
500 template<typename _Res, typename _Arg>
501 static _Setter<_Res, _Arg&&>
502 __setter(promise<_Res>* __prom, _Arg&& __arg)
504 return _Setter<_Res, _Arg&&>{ __prom, &__arg };
507 template<typename _Res>
508 static _Setter<_Res, __exception_ptr_tag>
509 __setter(exception_ptr& __ex, promise<_Res>* __prom)
511 return _Setter<_Res, __exception_ptr_tag>{ __prom, &__ex };
514 template<typename _Tp>
516 _S_check(const shared_ptr<_Tp>& __p)
518 if (!static_cast<bool>(__p))
519 __throw_future_error((int)future_errc::no_state);
523 // The function invoked with std::call_once(_M_once, ...).
525 _M_do_set(function<_Ptr_type()>* __f, bool* __did_set)
527 _Ptr_type __res = (*__f)();
528 // Notify the caller that we did try to set; if we do not throw an
529 // exception, the caller will be aware that it did set (e.g., see
532 _M_result.swap(__res); // nothrow
535 // Wait for completion of async function.
536 virtual void _M_complete_async() { }
538 // Return true if state corresponds to a deferred function.
539 virtual bool _M_is_deferred_future() const { return false; }
541 struct _Make_ready final : __at_thread_exit_elt
543 weak_ptr<_State_baseV2> _M_shared_state;
544 static void _S_run(void*);
549 #ifdef _GLIBCXX_ASYNC_ABI_COMPAT
551 class _Async_state_common;
553 using _State_base = _State_baseV2;
554 class _Async_state_commonV2;
557 template<typename _BoundFn, typename = typename _BoundFn::result_type>
558 class _Deferred_state;
560 template<typename _BoundFn, typename = typename _BoundFn::result_type>
561 class _Async_state_impl;
563 template<typename _Signature>
564 class _Task_state_base;
566 template<typename _Fn, typename _Alloc, typename _Signature>
569 template<typename _BoundFn>
570 static std::shared_ptr<_State_base>
571 _S_make_deferred_state(_BoundFn&& __fn);
573 template<typename _BoundFn>
574 static std::shared_ptr<_State_base>
575 _S_make_async_state(_BoundFn&& __fn);
577 template<typename _Res_ptr, typename _Fn,
578 typename _Res = typename _Res_ptr::element_type::result_type>
581 template<typename _Res_ptr, typename _BoundFn>
582 static _Task_setter<_Res_ptr, _BoundFn>
583 _S_task_setter(_Res_ptr& __ptr, _BoundFn& __call)
585 return { std::__addressof(__ptr), std::__addressof(__call) };
589 /// Partial specialization for reference types.
590 template<typename _Res>
591 struct __future_base::_Result<_Res&> : __future_base::_Result_base
593 typedef _Res& result_type;
595 _Result() noexcept : _M_value_ptr() { }
598 _M_set(_Res& __res) noexcept
599 { _M_value_ptr = std::addressof(__res); }
601 _Res& _M_get() noexcept { return *_M_value_ptr; }
606 void _M_destroy() { delete this; }
609 /// Explicit specialization for void.
611 struct __future_base::_Result<void> : __future_base::_Result_base
613 typedef void result_type;
616 void _M_destroy() { delete this; }
619 #ifndef _GLIBCXX_ASYNC_ABI_COMPAT
621 // Allow _Setter objects to be stored locally in std::function
622 template<typename _Res, typename _Arg>
623 struct __is_location_invariant
624 <__future_base::_State_base::_Setter<_Res, _Arg>>
627 // Allow _Task_setter objects to be stored locally in std::function
628 template<typename _Res_ptr, typename _Fn, typename _Res>
629 struct __is_location_invariant
630 <__future_base::_Task_setter<_Res_ptr, _Fn, _Res>>
633 /// Common implementation for future and shared_future.
634 template<typename _Res>
635 class __basic_future : public __future_base
638 typedef shared_ptr<_State_base> __state_type;
639 typedef __future_base::_Result<_Res>& __result_type;
642 __state_type _M_state;
646 __basic_future(const __basic_future&) = delete;
647 __basic_future& operator=(const __basic_future&) = delete;
650 valid() const noexcept { return static_cast<bool>(_M_state); }
655 _State_base::_S_check(_M_state);
659 template<typename _Rep, typename _Period>
661 wait_for(const chrono::duration<_Rep, _Period>& __rel) const
663 _State_base::_S_check(_M_state);
664 return _M_state->wait_for(__rel);
667 template<typename _Clock, typename _Duration>
669 wait_until(const chrono::time_point<_Clock, _Duration>& __abs) const
671 _State_base::_S_check(_M_state);
672 return _M_state->wait_until(__abs);
676 /// Wait for the state to be ready and rethrow any stored exception
678 _M_get_result() const
680 _State_base::_S_check(_M_state);
681 _Result_base& __res = _M_state->wait();
682 if (!(__res._M_error == 0))
683 rethrow_exception(__res._M_error);
684 return static_cast<__result_type>(__res);
687 void _M_swap(__basic_future& __that) noexcept
689 _M_state.swap(__that._M_state);
692 // Construction of a future by promise::get_future()
694 __basic_future(const __state_type& __state) : _M_state(__state)
696 _State_base::_S_check(_M_state);
697 _M_state->_M_set_retrieved_flag();
700 // Copy construction from a shared_future
702 __basic_future(const shared_future<_Res>&) noexcept;
704 // Move construction from a shared_future
706 __basic_future(shared_future<_Res>&&) noexcept;
708 // Move construction from a future
710 __basic_future(future<_Res>&&) noexcept;
712 constexpr __basic_future() noexcept : _M_state() { }
716 explicit _Reset(__basic_future& __fut) noexcept : _M_fut(__fut) { }
717 ~_Reset() { _M_fut._M_state.reset(); }
718 __basic_future& _M_fut;
723 /// Primary template for future.
724 template<typename _Res>
725 class future : public __basic_future<_Res>
727 friend class promise<_Res>;
728 template<typename> friend class packaged_task;
729 template<typename _Fn, typename... _Args>
730 friend future<typename result_of<_Fn(_Args...)>::type>
731 async(launch, _Fn&&, _Args&&...);
733 typedef __basic_future<_Res> _Base_type;
734 typedef typename _Base_type::__state_type __state_type;
737 future(const __state_type& __state) : _Base_type(__state) { }
740 constexpr future() noexcept : _Base_type() { }
743 future(future&& __uf) noexcept : _Base_type(std::move(__uf)) { }
746 future(const future&) = delete;
747 future& operator=(const future&) = delete;
749 future& operator=(future&& __fut) noexcept
751 future(std::move(__fut))._M_swap(*this);
755 /// Retrieving the value
759 typename _Base_type::_Reset __reset(*this);
760 return std::move(this->_M_get_result()._M_value());
763 shared_future<_Res> share();
766 /// Partial specialization for future<R&>
767 template<typename _Res>
768 class future<_Res&> : public __basic_future<_Res&>
770 friend class promise<_Res&>;
771 template<typename> friend class packaged_task;
772 template<typename _Fn, typename... _Args>
773 friend future<typename result_of<_Fn(_Args...)>::type>
774 async(launch, _Fn&&, _Args&&...);
776 typedef __basic_future<_Res&> _Base_type;
777 typedef typename _Base_type::__state_type __state_type;
780 future(const __state_type& __state) : _Base_type(__state) { }
783 constexpr future() noexcept : _Base_type() { }
786 future(future&& __uf) noexcept : _Base_type(std::move(__uf)) { }
789 future(const future&) = delete;
790 future& operator=(const future&) = delete;
792 future& operator=(future&& __fut) noexcept
794 future(std::move(__fut))._M_swap(*this);
798 /// Retrieving the value
802 typename _Base_type::_Reset __reset(*this);
803 return this->_M_get_result()._M_get();
806 shared_future<_Res&> share();
809 /// Explicit specialization for future<void>
811 class future<void> : public __basic_future<void>
813 friend class promise<void>;
814 template<typename> friend class packaged_task;
815 template<typename _Fn, typename... _Args>
816 friend future<typename result_of<_Fn(_Args...)>::type>
817 async(launch, _Fn&&, _Args&&...);
819 typedef __basic_future<void> _Base_type;
820 typedef typename _Base_type::__state_type __state_type;
823 future(const __state_type& __state) : _Base_type(__state) { }
826 constexpr future() noexcept : _Base_type() { }
829 future(future&& __uf) noexcept : _Base_type(std::move(__uf)) { }
832 future(const future&) = delete;
833 future& operator=(const future&) = delete;
835 future& operator=(future&& __fut) noexcept
837 future(std::move(__fut))._M_swap(*this);
841 /// Retrieving the value
845 typename _Base_type::_Reset __reset(*this);
846 this->_M_get_result();
849 shared_future<void> share();
853 /// Primary template for shared_future.
854 template<typename _Res>
855 class shared_future : public __basic_future<_Res>
857 typedef __basic_future<_Res> _Base_type;
860 constexpr shared_future() noexcept : _Base_type() { }
863 shared_future(const shared_future& __sf) : _Base_type(__sf) { }
865 /// Construct from a future rvalue
866 shared_future(future<_Res>&& __uf) noexcept
867 : _Base_type(std::move(__uf))
870 /// Construct from a shared_future rvalue
871 shared_future(shared_future&& __sf) noexcept
872 : _Base_type(std::move(__sf))
875 shared_future& operator=(const shared_future& __sf)
877 shared_future(__sf)._M_swap(*this);
881 shared_future& operator=(shared_future&& __sf) noexcept
883 shared_future(std::move(__sf))._M_swap(*this);
887 /// Retrieving the value
889 get() const { return this->_M_get_result()._M_value(); }
892 /// Partial specialization for shared_future<R&>
893 template<typename _Res>
894 class shared_future<_Res&> : 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) : _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)
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_get(); }
931 /// Explicit specialization for shared_future<void>
933 class shared_future<void> : public __basic_future<void>
935 typedef __basic_future<void> _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<void>&& __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 { this->_M_get_result(); }
970 // Now we can define the protected __basic_future constructors.
971 template<typename _Res>
972 inline __basic_future<_Res>::
973 __basic_future(const shared_future<_Res>& __sf) noexcept
974 : _M_state(__sf._M_state)
977 template<typename _Res>
978 inline __basic_future<_Res>::
979 __basic_future(shared_future<_Res>&& __sf) noexcept
980 : _M_state(std::move(__sf._M_state))
983 template<typename _Res>
984 inline __basic_future<_Res>::
985 __basic_future(future<_Res>&& __uf) noexcept
986 : _M_state(std::move(__uf._M_state))
989 template<typename _Res>
990 inline shared_future<_Res>
991 future<_Res>::share()
992 { return shared_future<_Res>(std::move(*this)); }
994 template<typename _Res>
995 inline shared_future<_Res&>
996 future<_Res&>::share()
997 { return shared_future<_Res&>(std::move(*this)); }
999 inline shared_future<void>
1000 future<void>::share()
1001 { return shared_future<void>(std::move(*this)); }
1003 /// Primary template for promise
1004 template<typename _Res>
1007 typedef __future_base::_State_base _State;
1008 typedef __future_base::_Result<_Res> _Res_type;
1009 typedef __future_base::_Ptr<_Res_type> _Ptr_type;
1010 template<typename, typename> friend class _State::_Setter;
1012 shared_ptr<_State> _M_future;
1013 _Ptr_type _M_storage;
1017 : _M_future(std::make_shared<_State>()),
1018 _M_storage(new _Res_type())
1021 promise(promise&& __rhs) noexcept
1022 : _M_future(std::move(__rhs._M_future)),
1023 _M_storage(std::move(__rhs._M_storage))
1026 template<typename _Allocator>
1027 promise(allocator_arg_t, const _Allocator& __a)
1028 : _M_future(std::allocate_shared<_State>(__a)),
1029 _M_storage(__future_base::_S_allocate_result<_Res>(__a))
1032 template<typename _Allocator>
1033 promise(allocator_arg_t, const _Allocator&, promise&& __rhs)
1034 : _M_future(std::move(__rhs._M_future)),
1035 _M_storage(std::move(__rhs._M_storage))
1038 promise(const promise&) = delete;
1042 if (static_cast<bool>(_M_future) && !_M_future.unique())
1043 _M_future->_M_break_promise(std::move(_M_storage));
1048 operator=(promise&& __rhs) noexcept
1050 promise(std::move(__rhs)).swap(*this);
1054 promise& operator=(const promise&) = delete;
1057 swap(promise& __rhs) noexcept
1059 _M_future.swap(__rhs._M_future);
1060 _M_storage.swap(__rhs._M_storage);
1063 // Retrieving the result
1066 { return future<_Res>(_M_future); }
1068 // Setting the result
1070 set_value(const _Res& __r)
1071 { _M_future->_M_set_result(_State::__setter(this, __r)); }
1074 set_value(_Res&& __r)
1075 { _M_future->_M_set_result(_State::__setter(this, std::move(__r))); }
1078 set_exception(exception_ptr __p)
1079 { _M_future->_M_set_result(_State::__setter(__p, this)); }
1082 set_value_at_thread_exit(const _Res& __r)
1084 _M_future->_M_set_delayed_result(_State::__setter(this, __r),
1089 set_value_at_thread_exit(_Res&& __r)
1091 _M_future->_M_set_delayed_result(
1092 _State::__setter(this, std::move(__r)), _M_future);
1096 set_exception_at_thread_exit(exception_ptr __p)
1098 _M_future->_M_set_delayed_result(_State::__setter(__p, this),
1103 template<typename _Res>
1105 swap(promise<_Res>& __x, promise<_Res>& __y) noexcept
1108 template<typename _Res, typename _Alloc>
1109 struct uses_allocator<promise<_Res>, _Alloc>
1110 : public true_type { };
1113 /// Partial specialization for promise<R&>
1114 template<typename _Res>
1115 class promise<_Res&>
1117 typedef __future_base::_State_base _State;
1118 typedef __future_base::_Result<_Res&> _Res_type;
1119 typedef __future_base::_Ptr<_Res_type> _Ptr_type;
1120 template<typename, typename> friend class _State::_Setter;
1122 shared_ptr<_State> _M_future;
1123 _Ptr_type _M_storage;
1127 : _M_future(std::make_shared<_State>()),
1128 _M_storage(new _Res_type())
1131 promise(promise&& __rhs) noexcept
1132 : _M_future(std::move(__rhs._M_future)),
1133 _M_storage(std::move(__rhs._M_storage))
1136 template<typename _Allocator>
1137 promise(allocator_arg_t, const _Allocator& __a)
1138 : _M_future(std::allocate_shared<_State>(__a)),
1139 _M_storage(__future_base::_S_allocate_result<_Res&>(__a))
1142 template<typename _Allocator>
1143 promise(allocator_arg_t, const _Allocator&, promise&& __rhs)
1144 : _M_future(std::move(__rhs._M_future)),
1145 _M_storage(std::move(__rhs._M_storage))
1148 promise(const promise&) = delete;
1152 if (static_cast<bool>(_M_future) && !_M_future.unique())
1153 _M_future->_M_break_promise(std::move(_M_storage));
1158 operator=(promise&& __rhs) noexcept
1160 promise(std::move(__rhs)).swap(*this);
1164 promise& operator=(const promise&) = delete;
1167 swap(promise& __rhs) noexcept
1169 _M_future.swap(__rhs._M_future);
1170 _M_storage.swap(__rhs._M_storage);
1173 // Retrieving the result
1176 { return future<_Res&>(_M_future); }
1178 // Setting the result
1180 set_value(_Res& __r)
1181 { _M_future->_M_set_result(_State::__setter(this, __r)); }
1184 set_exception(exception_ptr __p)
1185 { _M_future->_M_set_result(_State::__setter(__p, this)); }
1188 set_value_at_thread_exit(_Res& __r)
1190 _M_future->_M_set_delayed_result(_State::__setter(this, __r),
1195 set_exception_at_thread_exit(exception_ptr __p)
1197 _M_future->_M_set_delayed_result(_State::__setter(__p, this),
1202 /// Explicit specialization for promise<void>
1206 typedef __future_base::_State_base _State;
1207 typedef __future_base::_Result<void> _Res_type;
1208 typedef __future_base::_Ptr<_Res_type> _Ptr_type;
1209 template<typename, typename> friend class _State::_Setter;
1211 shared_ptr<_State> _M_future;
1212 _Ptr_type _M_storage;
1216 : _M_future(std::make_shared<_State>()),
1217 _M_storage(new _Res_type())
1220 promise(promise&& __rhs) noexcept
1221 : _M_future(std::move(__rhs._M_future)),
1222 _M_storage(std::move(__rhs._M_storage))
1225 template<typename _Allocator>
1226 promise(allocator_arg_t, const _Allocator& __a)
1227 : _M_future(std::allocate_shared<_State>(__a)),
1228 _M_storage(__future_base::_S_allocate_result<void>(__a))
1231 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1232 // 2095. missing constructors needed for uses-allocator construction
1233 template<typename _Allocator>
1234 promise(allocator_arg_t, const _Allocator&, promise&& __rhs)
1235 : _M_future(std::move(__rhs._M_future)),
1236 _M_storage(std::move(__rhs._M_storage))
1239 promise(const promise&) = delete;
1243 if (static_cast<bool>(_M_future) && !_M_future.unique())
1244 _M_future->_M_break_promise(std::move(_M_storage));
1249 operator=(promise&& __rhs) noexcept
1251 promise(std::move(__rhs)).swap(*this);
1255 promise& operator=(const promise&) = delete;
1258 swap(promise& __rhs) noexcept
1260 _M_future.swap(__rhs._M_future);
1261 _M_storage.swap(__rhs._M_storage);
1264 // Retrieving the result
1267 { return future<void>(_M_future); }
1269 // Setting the result
1273 set_exception(exception_ptr __p)
1274 { _M_future->_M_set_result(_State::__setter(__p, this)); }
1277 set_value_at_thread_exit();
1280 set_exception_at_thread_exit(exception_ptr __p)
1282 _M_future->_M_set_delayed_result(_State::__setter(__p, this),
1289 struct __future_base::_State_base::_Setter<void, void>
1291 promise<void>::_Ptr_type operator()() const
1293 _State_base::_S_check(_M_promise->_M_future);
1294 return std::move(_M_promise->_M_storage);
1297 promise<void>* _M_promise;
1301 promise<void>::set_value()
1302 { _M_future->_M_set_result(_State::_Setter<void, void>{ this }); }
1305 promise<void>::set_value_at_thread_exit()
1307 _M_future->_M_set_delayed_result(_State::_Setter<void, void>{this},
1311 template<typename _Ptr_type, typename _Fn, typename _Res>
1312 struct __future_base::_Task_setter
1314 // Invoke the function and provide the result to the caller.
1315 _Ptr_type operator()() const
1319 (*_M_result)->_M_set((*_M_fn)());
1321 __catch(const __cxxabiv1::__forced_unwind&)
1323 __throw_exception_again; // will cause broken_promise
1327 (*_M_result)->_M_error = current_exception();
1329 return std::move(*_M_result);
1331 _Ptr_type* _M_result;
1335 template<typename _Ptr_type, typename _Fn>
1336 struct __future_base::_Task_setter<_Ptr_type, _Fn, void>
1338 _Ptr_type operator()() const
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 // Holds storage for a packaged_task's result.
1359 template<typename _Res, typename... _Args>
1360 struct __future_base::_Task_state_base<_Res(_Args...)>
1361 : __future_base::_State_base
1363 typedef _Res _Res_type;
1365 template<typename _Alloc>
1366 _Task_state_base(const _Alloc& __a)
1367 : _M_result(_S_allocate_result<_Res>(__a))
1370 // Invoke the stored task and make the state ready.
1372 _M_run(_Args&&... __args) = 0;
1374 // Invoke the stored task and make the state ready at thread exit.
1376 _M_run_delayed(_Args&&... __args, weak_ptr<_State_base>) = 0;
1378 virtual shared_ptr<_Task_state_base>
1381 typedef __future_base::_Ptr<_Result<_Res>> _Ptr_type;
1382 _Ptr_type _M_result;
1385 // Holds a packaged_task's stored task.
1386 template<typename _Fn, typename _Alloc, typename _Res, typename... _Args>
1387 struct __future_base::_Task_state<_Fn, _Alloc, _Res(_Args...)> final
1388 : __future_base::_Task_state_base<_Res(_Args...)>
1390 template<typename _Fn2>
1391 _Task_state(_Fn2&& __fn, const _Alloc& __a)
1392 : _Task_state_base<_Res(_Args...)>(__a),
1393 _M_impl(std::forward<_Fn2>(__fn), __a)
1398 _M_run(_Args&&... __args)
1400 // bound arguments decay so wrap lvalue references
1401 auto __boundfn = std::__bind_simple(std::ref(_M_impl._M_fn),
1402 _S_maybe_wrap_ref(std::forward<_Args>(__args))...);
1403 this->_M_set_result(_S_task_setter(this->_M_result, __boundfn));
1407 _M_run_delayed(_Args&&... __args, weak_ptr<_State_base> __self)
1409 // bound arguments decay so wrap lvalue references
1410 auto __boundfn = std::__bind_simple(std::ref(_M_impl._M_fn),
1411 _S_maybe_wrap_ref(std::forward<_Args>(__args))...);
1412 this->_M_set_delayed_result(_S_task_setter(this->_M_result, __boundfn),
1416 virtual shared_ptr<_Task_state_base<_Res(_Args...)>>
1419 template<typename _Tp>
1420 static reference_wrapper<_Tp>
1421 _S_maybe_wrap_ref(_Tp& __t)
1422 { return std::ref(__t); }
1424 template<typename _Tp>
1426 typename enable_if<!is_lvalue_reference<_Tp>::value, _Tp>::type&&
1427 _S_maybe_wrap_ref(_Tp&& __t)
1428 { return std::forward<_Tp>(__t); }
1430 struct _Impl : _Alloc
1432 template<typename _Fn2>
1433 _Impl(_Fn2&& __fn, const _Alloc& __a)
1434 : _Alloc(__a), _M_fn(std::forward<_Fn2>(__fn)) { }
1439 template<typename _Signature, typename _Fn, typename _Alloc>
1440 static shared_ptr<__future_base::_Task_state_base<_Signature>>
1441 __create_task_state(_Fn&& __fn, const _Alloc& __a)
1443 typedef typename decay<_Fn>::type _Fn2;
1444 typedef __future_base::_Task_state<_Fn2, _Alloc, _Signature> _State;
1445 return std::allocate_shared<_State>(__a, std::forward<_Fn>(__fn), __a);
1448 template<typename _Fn, typename _Alloc, typename _Res, typename... _Args>
1449 shared_ptr<__future_base::_Task_state_base<_Res(_Args...)>>
1450 __future_base::_Task_state<_Fn, _Alloc, _Res(_Args...)>::_M_reset()
1452 return __create_task_state<_Res(_Args...)>(std::move(_M_impl._M_fn),
1453 static_cast<_Alloc&>(_M_impl));
1456 template<typename _Task, typename _Fn, bool
1457 = is_same<_Task, typename decay<_Fn>::type>::value>
1458 struct __constrain_pkgdtask
1459 { typedef void __type; };
1461 template<typename _Task, typename _Fn>
1462 struct __constrain_pkgdtask<_Task, _Fn, true>
1466 template<typename _Res, typename... _ArgTypes>
1467 class packaged_task<_Res(_ArgTypes...)>
1469 typedef __future_base::_Task_state_base<_Res(_ArgTypes...)> _State_type;
1470 shared_ptr<_State_type> _M_state;
1473 // Construction and destruction
1474 packaged_task() noexcept { }
1476 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1477 // 2095. missing constructors needed for uses-allocator construction
1478 template<typename _Allocator>
1479 packaged_task(allocator_arg_t, const _Allocator& __a) noexcept
1482 template<typename _Fn, typename = typename
1483 __constrain_pkgdtask<packaged_task, _Fn>::__type>
1485 packaged_task(_Fn&& __fn)
1486 : packaged_task(allocator_arg, std::allocator<int>(),
1487 std::forward<_Fn>(__fn))
1490 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1491 // 2097. packaged_task constructors should be constrained
1492 template<typename _Fn, typename _Alloc, typename = typename
1493 __constrain_pkgdtask<packaged_task, _Fn>::__type>
1495 packaged_task(allocator_arg_t, const _Alloc& __a, _Fn&& __fn)
1496 : _M_state(__create_task_state<_Res(_ArgTypes...)>(
1497 std::forward<_Fn>(__fn), __a))
1502 if (static_cast<bool>(_M_state) && !_M_state.unique())
1503 _M_state->_M_break_promise(std::move(_M_state->_M_result));
1507 packaged_task(const packaged_task&) = delete;
1508 packaged_task& operator=(const packaged_task&) = delete;
1510 template<typename _Allocator>
1511 packaged_task(allocator_arg_t, const _Allocator&,
1512 const packaged_task&) = delete;
1515 packaged_task(packaged_task&& __other) noexcept
1516 { this->swap(__other); }
1518 template<typename _Allocator>
1519 packaged_task(allocator_arg_t, const _Allocator&,
1520 packaged_task&& __other) noexcept
1521 { this->swap(__other); }
1523 packaged_task& operator=(packaged_task&& __other) noexcept
1525 packaged_task(std::move(__other)).swap(*this);
1530 swap(packaged_task& __other) noexcept
1531 { _M_state.swap(__other._M_state); }
1534 valid() const noexcept
1535 { return static_cast<bool>(_M_state); }
1540 { return future<_Res>(_M_state); }
1544 operator()(_ArgTypes... __args)
1546 __future_base::_State_base::_S_check(_M_state);
1547 _M_state->_M_run(std::forward<_ArgTypes>(__args)...);
1551 make_ready_at_thread_exit(_ArgTypes... __args)
1553 __future_base::_State_base::_S_check(_M_state);
1554 _M_state->_M_run_delayed(std::forward<_ArgTypes>(__args)..., _M_state);
1560 __future_base::_State_base::_S_check(_M_state);
1561 packaged_task __tmp;
1562 __tmp._M_state = _M_state;
1563 _M_state = _M_state->_M_reset();
1568 template<typename _Res, typename... _ArgTypes>
1570 swap(packaged_task<_Res(_ArgTypes...)>& __x,
1571 packaged_task<_Res(_ArgTypes...)>& __y) noexcept
1574 template<typename _Res, typename _Alloc>
1575 struct uses_allocator<packaged_task<_Res>, _Alloc>
1576 : public true_type { };
1579 // Shared state created by std::async().
1580 // Holds a deferred function and storage for its result.
1581 template<typename _BoundFn, typename _Res>
1582 class __future_base::_Deferred_state final
1583 : public __future_base::_State_base
1587 _Deferred_state(_BoundFn&& __fn)
1588 : _M_result(new _Result<_Res>()), _M_fn(std::move(__fn))
1592 typedef __future_base::_Ptr<_Result<_Res>> _Ptr_type;
1593 _Ptr_type _M_result;
1596 // Run the deferred function.
1600 // Multiple threads can call a waiting function on the future and
1601 // reach this point at the same time. The call_once in _M_set_result
1602 // ensures only the first one run the deferred function, stores the
1603 // result in _M_result, swaps that with the base _M_result and makes
1604 // the state ready. Tell _M_set_result to ignore failure so all later
1605 // calls do nothing.
1606 _M_set_result(_S_task_setter(_M_result, _M_fn), true);
1609 // Caller should check whether the state is ready first, because this
1610 // function will return true even after the deferred function has run.
1611 virtual bool _M_is_deferred_future() const { return true; }
1614 // Common functionality hoisted out of the _Async_state_impl template.
1615 class __future_base::_Async_state_commonV2
1616 : public __future_base::_State_base
1619 ~_Async_state_commonV2() = default;
1621 // Make waiting functions block until the thread completes, as if joined.
1623 // This function is used by wait() to satisfy the first requirement below
1624 // and by wait_for() / wait_until() to satisfy the second.
1628 // — a call to a waiting function on an asynchronous return object that
1629 // shares the shared state created by this async call shall block until
1630 // the associated thread has completed, as if joined, or else time out.
1632 // — the associated thread completion synchronizes with the return from
1633 // the first function that successfully detects the ready status of the
1634 // shared state or with the return from the last function that releases
1635 // the shared state, whichever happens first.
1636 virtual void _M_complete_async() { _M_join(); }
1638 void _M_join() { std::call_once(_M_once, &thread::join, ref(_M_thread)); }
1644 // Shared state created by std::async().
1645 // Starts a new thread that runs a function and makes the shared state ready.
1646 template<typename _BoundFn, typename _Res>
1647 class __future_base::_Async_state_impl final
1648 : public __future_base::_Async_state_commonV2
1652 _Async_state_impl(_BoundFn&& __fn)
1653 : _M_result(new _Result<_Res>()), _M_fn(std::move(__fn))
1655 _M_thread = std::thread{ [this] {
1658 _M_set_result(_S_task_setter(_M_result, _M_fn));
1660 __catch (const __cxxabiv1::__forced_unwind&)
1662 // make the shared state ready on thread cancellation
1663 if (static_cast<bool>(_M_result))
1664 this->_M_break_promise(std::move(_M_result));
1665 __throw_exception_again;
1670 // Must not destroy _M_result and _M_fn until the thread finishes.
1671 // Call join() directly rather than through _M_join() because no other
1672 // thread can be referring to this state if it is being destroyed.
1673 ~_Async_state_impl() { if (_M_thread.joinable()) _M_thread.join(); }
1676 typedef __future_base::_Ptr<_Result<_Res>> _Ptr_type;
1677 _Ptr_type _M_result;
1681 template<typename _BoundFn>
1682 inline std::shared_ptr<__future_base::_State_base>
1683 __future_base::_S_make_deferred_state(_BoundFn&& __fn)
1685 typedef typename remove_reference<_BoundFn>::type __fn_type;
1686 typedef _Deferred_state<__fn_type> __state_type;
1687 return std::make_shared<__state_type>(std::move(__fn));
1690 template<typename _BoundFn>
1691 inline std::shared_ptr<__future_base::_State_base>
1692 __future_base::_S_make_async_state(_BoundFn&& __fn)
1694 typedef typename remove_reference<_BoundFn>::type __fn_type;
1695 typedef _Async_state_impl<__fn_type> __state_type;
1696 return std::make_shared<__state_type>(std::move(__fn));
1701 template<typename _Fn, typename... _Args>
1702 future<typename result_of<_Fn(_Args...)>::type>
1703 async(launch __policy, _Fn&& __fn, _Args&&... __args)
1705 typedef typename result_of<_Fn(_Args...)>::type result_type;
1706 std::shared_ptr<__future_base::_State_base> __state;
1707 if ((__policy & (launch::async|launch::deferred)) == launch::async)
1709 __state = __future_base::_S_make_async_state(std::__bind_simple(
1710 std::forward<_Fn>(__fn), std::forward<_Args>(__args)...));
1714 __state = __future_base::_S_make_deferred_state(std::__bind_simple(
1715 std::forward<_Fn>(__fn), std::forward<_Args>(__args)...));
1717 return future<result_type>(__state);
1720 /// async, potential overload
1721 template<typename _Fn, typename... _Args>
1722 inline future<typename result_of<_Fn(_Args...)>::type>
1723 async(_Fn&& __fn, _Args&&... __args)
1725 return async(launch::async|launch::deferred, std::forward<_Fn>(__fn),
1726 std::forward<_Args>(__args)...);
1729 #endif // _GLIBCXX_ASYNC_ABI_COMPAT
1730 #endif // _GLIBCXX_HAS_GTHREADS && _GLIBCXX_USE_C99_STDINT_TR1
1731 // && ATOMIC_INT_LOCK_FREE
1734 _GLIBCXX_END_NAMESPACE_VERSION
1739 #endif // _GLIBCXX_FUTURE