// <thread> -*- C++ -*-
-// Copyright (C) 2008, 2009 Free Software Foundation, Inc.
+// Copyright (C) 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
// terms of the GNU General Public License as published by the
-// Free Software Foundation; either version 2, or (at your option)
+// Free Software Foundation; either version 3, or (at your option)
// any later version.
// This library is distributed in the hope that it will be useful,
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
-// You should have received a copy of the GNU General Public License
-// along with this library; see the file COPYING. If not, write to
-// the Free Software Foundation, 51 Franklin Street, Fifth Floor,
-// Boston, MA 02110-1301, USA.
-
-// As a special exception, you may use this file as part of a free software
-// library without restriction. Specifically, if other files instantiate
-// templates or use macros or inline functions from this file, or you compile
-// this file and link it with other files to produce an executable, this
-// file does not by itself cause the resulting executable to be covered by
-// the GNU General Public License. This exception does not however
-// invalidate any other reasons why the executable file might be covered by
-// the GNU General Public License.
-
-/** @file thread
+// Under Section 7 of GPL version 3, you are granted additional
+// permissions described in the GCC Runtime Library Exception, version
+// 3.1, as published by the Free Software Foundation.
+
+// You should have received a copy of the GNU General Public License and
+// a copy of the GCC Runtime Library Exception along with this program;
+// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
+// <http://www.gnu.org/licenses/>.
+
+/** @file include/thread
* This is a Standard C++ Library header.
*/
#pragma GCC system_header
#ifndef __GXX_EXPERIMENTAL_CXX0X__
-# include <c++0x_warning.h>
+# include <bits/c++0x_warning.h>
#else
#include <chrono>
-#include <exception>
#include <functional>
#include <memory>
#include <mutex>
#include <condition_variable>
-#include <type_traits>
-#include <cstddef>
#include <bits/functexcept.h>
+#include <bits/functional_hash.h>
#include <bits/gthr.h>
#if defined(_GLIBCXX_HAS_GTHREADS) && defined(_GLIBCXX_USE_C99_STDINT_TR1)
-namespace std
+namespace std _GLIBCXX_VISIBILITY(default)
{
- class __thread_data_base;
+_GLIBCXX_BEGIN_NAMESPACE_VERSION
- typedef shared_ptr<__thread_data_base> __thread_data_ptr;
+ /**
+ * @defgroup threads Threads
+ * @ingroup concurrency
+ *
+ * Classes for thread support.
+ * @{
+ */
- class __thread_data_base : public enable_shared_from_this<__thread_data_base>
+ /// thread
+ class thread
{
public:
- __thread_data_base() = default;
- virtual ~__thread_data_base() = default;
-
- virtual void _M_run() = 0;
-
- __gthread_t _M_thread_handle;
- __thread_data_ptr _M_this_ptr;
- mutex _M_data_mutex;
- };
-
- template<typename _Callable>
- class __thread_data : public __thread_data_base
+ typedef __gthread_t native_handle_type;
+ struct _Impl_base;
+ typedef shared_ptr<_Impl_base> __shared_base_type;
+
+ /// thread::id
+ class id
{
+ native_handle_type _M_thread;
+
public:
- __thread_data(_Callable&& __f)
- : _M_func(std::forward<_Callable>(__f))
- { }
+ id() noexcept : _M_thread() { }
- void _M_run()
- { _M_func(); }
+ explicit
+ id(native_handle_type __id) : _M_thread(__id) { }
private:
- _Callable _M_func;
+ friend class thread;
+ friend class hash<thread::id>;
+
+ friend bool
+ operator==(thread::id __x, thread::id __y) noexcept
+ { return __gthread_equal(__x._M_thread, __y._M_thread); }
+
+ friend bool
+ operator<(thread::id __x, thread::id __y) noexcept
+ { return __x._M_thread < __y._M_thread; }
+
+ template<class _CharT, class _Traits>
+ friend basic_ostream<_CharT, _Traits>&
+ operator<<(basic_ostream<_CharT, _Traits>& __out, thread::id __id);
};
- /// thread
- class thread
- {
- public:
- // types
- class id;
- typedef __gthread_t native_handle_type;
+ // Simple base type that the templatized, derived class containing
+ // an arbitrary functor can be converted to and called.
+ struct _Impl_base
+ {
+ __shared_base_type _M_this_ptr;
+
+ inline virtual ~_Impl_base();
+
+ virtual void _M_run() = 0;
+ };
- // cons
- thread() = default;
-
template<typename _Callable>
- explicit thread(_Callable __f)
- : _M_thread_data(_M_make_thread_data(__f))
- { _M_start_thread(); }
+ struct _Impl : public _Impl_base
+ {
+ _Callable _M_func;
- template<typename _Callable, typename... _Args>
- thread(_Callable&& __f, _Args&&... __args)
- : _M_thread_data(_M_make_thread_data(std::bind(__f, __args...)))
- { _M_start_thread(); }
+ _Impl(_Callable&& __f) : _M_func(std::forward<_Callable>(__f))
+ { }
- ~thread()
- { detach(); }
+ void
+ _M_run() { _M_func(); }
+ };
+ private:
+ id _M_id;
+
+ public:
+ thread() noexcept = default;
+ thread(thread&) = delete;
thread(const thread&) = delete;
- thread(thread&& __t)
+
+ thread(thread&& __t) noexcept
{ swap(__t); }
+ template<typename _Callable, typename... _Args>
+ explicit
+ thread(_Callable&& __f, _Args&&... __args)
+ {
+ _M_start_thread(_M_make_routine(std::bind<void>(
+ std::forward<_Callable>(__f),
+ std::forward<_Args>(__args)...)));
+ }
+
+ ~thread()
+ {
+ if (joinable())
+ std::terminate();
+ }
+
thread& operator=(const thread&) = delete;
- thread& operator=(thread&& __t)
+
+ thread& operator=(thread&& __t) noexcept
{
if (joinable())
- detach();
+ std::terminate();
swap(__t);
return *this;
}
- // members
- void
- swap(thread&& __t)
- { std::swap(_M_thread_data, __t._M_thread_data); }
+ void
+ swap(thread& __t) noexcept
+ { std::swap(_M_id, __t._M_id); }
- bool
- joinable() const;
+ bool
+ joinable() const noexcept
+ { return !(_M_id == id()); }
- void
+ void
join();
- void
+ void
detach();
thread::id
- get_id() const;
+ get_id() const noexcept
+ { return _M_id; }
- native_handle_type
+ /** @pre thread is joinable
+ */
+ native_handle_type
native_handle()
- { return _M_thread_data->_M_thread_handle; }
-
- // static members
- static unsigned hardware_concurrency();
+ { return _M_id._M_thread; }
- __thread_data_ptr
- _M_get_thread_data() const
- {
- lock_guard<mutex> __l(_M_thread_data_mutex);
- return _M_thread_data;
- }
+ // Returns a value that hints at the number of hardware thread contexts.
+ static unsigned int
+ hardware_concurrency() noexcept
+ { return 0; }
private:
+ void
+ _M_start_thread(__shared_base_type);
+
template<typename _Callable>
- __thread_data_ptr
- _M_make_thread_data(_Callable&& __f)
- {
- return __thread_data_ptr(
- new __thread_data<_Callable>(std::forward<_Callable>(__f)));
+ shared_ptr<_Impl<_Callable>>
+ _M_make_routine(_Callable&& __f)
+ {
+ // Create and allocate full data structure, not base.
+ return make_shared<_Impl<_Callable>>(std::forward<_Callable>(__f));
}
-
- __thread_data_ptr
- _M_make_thread_data(void(*__f)())
- { return __thread_data_ptr(new __thread_data<void(*)()>(__f)); }
-
- void _M_start_thread();
-
- __thread_data_ptr _M_thread_data;
- mutable mutex _M_thread_data_mutex;
};
- inline void
- swap(thread& __x, thread& __y)
- { __x.swap(__y); }
+ inline thread::_Impl_base::~_Impl_base() = default;
inline void
- swap(thread&& __x, thread& __y)
- { __x.swap(__y); }
-
- inline void
- swap(thread& __x, thread&& __y)
+ swap(thread& __x, thread& __y) noexcept
{ __x.swap(__y); }
+ inline bool
+ operator!=(thread::id __x, thread::id __y) noexcept
+ { return !(__x == __y); }
+
+ inline bool
+ operator<=(thread::id __x, thread::id __y) noexcept
+ { return !(__y < __x); }
+
+ inline bool
+ operator>(thread::id __x, thread::id __y) noexcept
+ { return __y < __x; }
+
+ inline bool
+ operator>=(thread::id __x, thread::id __y) noexcept
+ { return !(__x < __y); }
+
+ // DR 889.
+ /// std::hash specialization for thread::id.
+ template<>
+ struct hash<thread::id>
+ : public __hash_base<size_t, thread::id>
+ {
+ size_t
+ operator()(const thread::id& __id) const
+ { return std::_Hash_impl::hash(__id._M_thread); }
+ };
+
+ template<class _CharT, class _Traits>
+ inline basic_ostream<_CharT, _Traits>&
+ operator<<(basic_ostream<_CharT, _Traits>& __out, thread::id __id)
+ {
+ if (__id == thread::id())
+ return __out << "thread::id of a non-executing thread";
+ else
+ return __out << __id._M_thread;
+ }
+
+_GLIBCXX_END_NAMESPACE_VERSION
+
+ /** @namespace std::this_thread
+ * @brief ISO C++ 0x entities sub namespace for thread.
+ * 30.2.2 Namespace this_thread.
+ */
namespace this_thread
{
- thread::id
- get_id();
+ _GLIBCXX_BEGIN_NAMESPACE_VERSION
+
+ /// get_id
+ inline thread::id
+ get_id() noexcept { return thread::id(__gthread_self()); }
#ifdef _GLIBCXX_USE_SCHED_YIELD
+ /// yield
inline void
- yield()
+ yield() noexcept
{ __gthread_yield(); }
#endif
#ifdef _GLIBCXX_USE_NANOSLEEP
- template<typename _Clock, typename _Duration>
- inline void
- sleep_until(const chrono::time_point<_Clock, _Duration>& __atime)
- { sleep_for(__atime - _Clock::now()); }
-
+ /// sleep_for
template<typename _Rep, typename _Period>
inline void
sleep_for(const chrono::duration<_Rep, _Period>& __rtime)
chrono::nanoseconds __ns =
chrono::duration_cast<chrono::nanoseconds>(__rtime - __s);
- __gthread_time_t __ts =
+ __gthread_time_t __ts =
{
static_cast<std::time_t>(__s.count()),
static_cast<long>(__ns.count())
::nanosleep(&__ts, 0);
}
-#endif
- }
-
- /// thread::id
- class thread::id
- {
- public:
- id() : _M_thread_id() { }
-
- private:
- friend class thread;
-
- friend thread::id this_thread::get_id();
-
- friend bool
- operator==(thread::id __x, thread::id __y)
- { return static_cast<bool>(__gthread_equal(__x._M_thread_id,
- __y._M_thread_id)); }
-
- friend bool
- operator<(thread::id __x, thread::id __y)
- { return __x._M_thread_id < __y._M_thread_id; }
- template<class _CharT, class _Traits>
- friend basic_ostream<_CharT, _Traits>&
- operator<<(basic_ostream<_CharT, _Traits>&& __out, thread::id __id);
-
- id(__gthread_t __id)
- : _M_thread_id(__id)
- { }
-
- __gthread_t _M_thread_id;
- };
-
- inline bool
- operator!=(thread::id __x, thread::id __y)
- { return !(__x == __y); }
-
- inline bool
- operator<=(thread::id __x, thread::id __y)
- { return !(__y < __x); }
-
- inline bool
- operator>(thread::id __x, thread::id __y)
- { return __y < __x; }
-
- inline bool
- operator>=(thread::id __x, thread::id __y)
- { return !(__x < __y); }
-
- template<class _CharT, class _Traits>
- inline basic_ostream<_CharT, _Traits>&
- operator<<(basic_ostream<_CharT, _Traits>&& __out, thread::id __id)
- {
- if(__id == thread::id())
- return __out << "non-executing thread";
- else
- return __out << __id._M_thread_id;
- }
-
- inline bool
- thread::joinable() const
- { return get_id() != thread::id(); }
+ /// sleep_until
+ template<typename _Clock, typename _Duration>
+ inline void
+ sleep_until(const chrono::time_point<_Clock, _Duration>& __atime)
+ { sleep_for(__atime - _Clock::now()); }
+#endif
- inline thread::id
- thread::get_id() const
- {
- if(_M_thread_data)
- return thread::id(_M_thread_data->_M_thread_handle);
- else
- return thread::id();
+ _GLIBCXX_END_NAMESPACE_VERSION
}
- namespace this_thread
- {
- inline thread::id
- get_id()
- { return thread::id(__gthread_self()); }
- }
-}
+ // @} group threads
+
+} // namespace
#endif // _GLIBCXX_HAS_GTHREADS && _GLIBCXX_USE_C99_STDINT_TR1