1 // <thread> -*- C++ -*-
3 // Copyright (C) 2008, 2009, 2010, 2011 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/thread
26 * This is a Standard C++ Library header.
29 #ifndef _GLIBCXX_THREAD
30 #define _GLIBCXX_THREAD 1
32 #pragma GCC system_header
34 #ifndef __GXX_EXPERIMENTAL_CXX0X__
35 # include <bits/c++0x_warning.h>
42 #include <condition_variable>
43 #include <bits/functexcept.h>
44 #include <bits/functional_hash.h>
45 #include <bits/gthr.h>
47 #if defined(_GLIBCXX_HAS_GTHREADS) && defined(_GLIBCXX_USE_C99_STDINT_TR1)
49 namespace std _GLIBCXX_VISIBILITY(default)
51 _GLIBCXX_BEGIN_NAMESPACE_VERSION
54 * @defgroup threads Threads
55 * @ingroup concurrency
57 * Classes for thread support.
65 typedef __gthread_t native_handle_type;
67 typedef shared_ptr<_Impl_base> __shared_base_type;
72 native_handle_type _M_thread;
75 id() : _M_thread() { }
78 id(native_handle_type __id) : _M_thread(__id) { }
82 friend class hash<thread::id>;
85 operator==(thread::id __x, thread::id __y)
86 { return __gthread_equal(__x._M_thread, __y._M_thread); }
89 operator<(thread::id __x, thread::id __y)
90 { return __x._M_thread < __y._M_thread; }
92 template<class _CharT, class _Traits>
93 friend basic_ostream<_CharT, _Traits>&
94 operator<<(basic_ostream<_CharT, _Traits>& __out, thread::id __id);
97 // Simple base type that the templatized, derived class containing
98 // an arbitrary functor can be converted to and called.
101 __shared_base_type _M_this_ptr;
103 inline virtual ~_Impl_base();
105 virtual void _M_run() = 0;
108 template<typename _Callable>
109 struct _Impl : public _Impl_base
113 _Impl(_Callable&& __f) : _M_func(std::forward<_Callable>(__f))
117 _M_run() { _M_func(); }
125 thread(thread&) = delete;
126 thread(const thread&) = delete;
131 template<typename _Callable, typename... _Args>
133 thread(_Callable&& __f, _Args&&... __args)
135 _M_start_thread(_M_make_routine(std::bind<void>(
136 std::forward<_Callable>(__f),
137 std::forward<_Args>(__args)...)));
146 thread& operator=(const thread&) = delete;
148 thread& operator=(thread&& __t)
158 { std::swap(_M_id, __t._M_id); }
162 { return !(_M_id == id()); }
174 /** @pre thread is joinable
178 { return _M_id._M_thread; }
180 // Returns a value that hints at the number of hardware thread contexts.
182 hardware_concurrency()
187 _M_start_thread(__shared_base_type);
189 template<typename _Callable>
190 shared_ptr<_Impl<_Callable>>
191 _M_make_routine(_Callable&& __f)
193 // Create and allocate full data structure, not base.
194 return make_shared<_Impl<_Callable>>(std::forward<_Callable>(__f));
198 inline thread::_Impl_base::~_Impl_base() = default;
201 swap(thread& __x, thread& __y)
205 operator!=(thread::id __x, thread::id __y)
206 { return !(__x == __y); }
209 operator<=(thread::id __x, thread::id __y)
210 { return !(__y < __x); }
213 operator>(thread::id __x, thread::id __y)
214 { return __y < __x; }
217 operator>=(thread::id __x, thread::id __y)
218 { return !(__x < __y); }
221 /// std::hash specialization for thread::id.
223 struct hash<thread::id>
224 : public __hash_base<size_t, thread::id>
227 operator()(const thread::id& __id) const
228 { return std::_Hash_impl::hash(__id._M_thread); }
231 template<class _CharT, class _Traits>
232 inline basic_ostream<_CharT, _Traits>&
233 operator<<(basic_ostream<_CharT, _Traits>& __out, thread::id __id)
235 if (__id == thread::id())
236 return __out << "thread::id of a non-executing thread";
238 return __out << __id._M_thread;
241 _GLIBCXX_END_NAMESPACE_VERSION
243 /** @namespace std::this_thread
244 * @brief ISO C++ 0x entities sub namespace for thread.
245 * 30.2.2 Namespace this_thread.
247 namespace this_thread
249 _GLIBCXX_BEGIN_NAMESPACE_VERSION
253 get_id() { return thread::id(__gthread_self()); }
255 #ifdef _GLIBCXX_USE_SCHED_YIELD
259 { __gthread_yield(); }
262 #ifdef _GLIBCXX_USE_NANOSLEEP
264 template<typename _Clock, typename _Duration>
266 sleep_until(const chrono::time_point<_Clock, _Duration>& __atime)
267 { sleep_for(__atime - _Clock::now()); }
270 template<typename _Rep, typename _Period>
272 sleep_for(const chrono::duration<_Rep, _Period>& __rtime)
274 chrono::seconds __s =
275 chrono::duration_cast<chrono::seconds>(__rtime);
277 chrono::nanoseconds __ns =
278 chrono::duration_cast<chrono::nanoseconds>(__rtime - __s);
280 __gthread_time_t __ts =
282 static_cast<std::time_t>(__s.count()),
283 static_cast<long>(__ns.count())
286 ::nanosleep(&__ts, 0);
290 _GLIBCXX_END_NAMESPACE_VERSION
297 #endif // _GLIBCXX_HAS_GTHREADS && _GLIBCXX_USE_C99_STDINT_TR1
299 #endif // __GXX_EXPERIMENTAL_CXX0X__
301 #endif // _GLIBCXX_THREAD