libstdc++-v3/include/std/thread

   1 // <thread> -*- C++ -*-
   2
   3 // Copyright (C) 2008, 2009 Free Software Foundation, Inc.
   4 //
   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 2, or (at your option)
   9 // any later version.
  10
  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.
  15
  16 // You should have received a copy of the GNU General Public License
  17 // along with this library; see the file COPYING.  If not, write to
  18 // the Free Software Foundation, 51 Franklin Street, Fifth Floor,
  19 // Boston, MA 02110-1301, USA.
  20
  21 // As a special exception, you may use this file as part of a free software
  22 // library without restriction.  Specifically, if other files instantiate
  23 // templates or use macros or inline functions from this file, or you compile
  24 // this file and link it with other files to produce an executable, this
  25 // file does not by itself cause the resulting executable to be covered by
  26 // the GNU General Public License.  This exception does not however
  27 // invalidate any other reasons why the executable file might be covered by
  28 // the GNU General Public License.
  29
  30 /** @file thread
  31  *  This is a Standard C++ Library header.
  32  */
  33
  34 #ifndef _GLIBCXX_THREAD
  35 #define _GLIBCXX_THREAD 1
  36
  37 #pragma GCC system_header
  38
  39 #ifndef __GXX_EXPERIMENTAL_CXX0X__
  40 # include <c++0x_warning.h>
  41 #else
  42
  43 #include <chrono>
  44 #include <exception>
  45 #include <functional>
  46 #include <memory>
  47 #include <mutex>
  48 #include <condition_variable>
  49 #include <type_traits>
  50 #include <cstddef>
  51 #include <bits/functexcept.h>
  52 #include <bits/gthr.h>
  53
  54 #if defined(_GLIBCXX_HAS_GTHREADS) && defined(_GLIBCXX_USE_C99_STDINT_TR1)
  55
  56 namespace std
  57 {
  58   class __thread_data_base;
  59
  60   typedef shared_ptr<__thread_data_base> __thread_data_ptr;
  61
  62   class __thread_data_base : public enable_shared_from_this<__thread_data_base>
  63   {
  64   public:
  65     __thread_data_base() = default;
  66     virtual ~__thread_data_base() = default;
  67
  68     virtual void __run() = 0;
  69
  70     __gthread_t         _M_thread_handle;
  71     __thread_data_ptr   _M_this_ptr;
  72     mutex               _M_data_mutex;
  73   };
  74
  75   template<typename _Callable>
  76     class __thread_data : public __thread_data_base
  77     {
  78     public:
  79       __thread_data(_Callable&& __f)
  80       : _M_func(std::forward<_Callable>(__f))
  81       { }
  82
  83       void __run()
  84       { _M_func(); }
  85
  86     private:
  87       _Callable _M_func;
  88     };
  89
  90   /// thread
  91   class thread
  92   {
  93   public:
  94     // types
  95     class id;
  96     typedef __gthread_t native_handle_type;
  97
  98     // cons
  99     thread() = default;
 100
 101     template<typename _Callable>
 102       explicit thread(_Callable __f)
 103       : _M_thread_data(__make_thread_data(__f))
 104       { __start_thread(); }
 105
 106     template<typename _Callable, typename... _Args>
 107       thread(_Callable&& __f, _Args&&... __args)
 108       : _M_thread_data(__make_thread_data(std::bind(__f, __args...)))
 109       { __start_thread(); }
 110
 111     ~thread()
 112     { detach(); }
 113
 114     thread(const thread&) = delete;
 115     thread(thread&&);
 116     thread& operator=(const thread&) = delete;
 117     thread& operator=(thread&&);
 118
 119     // members
 120     void
 121     swap(thread&& __t)
 122     { std::swap(_M_thread_data, __t._M_thread_data); }
 123
 124     bool
 125     joinable() const;
 126
 127     void
 128     join();
 129
 130     void
 131     detach();
 132
 133     thread::id
 134     get_id() const;
 135
 136     native_handle_type
 137     native_handle()
 138     { return _M_thread_data->_M_thread_handle; }
 139
 140     // static members
 141     static unsigned hardware_concurrency();
 142
 143     __thread_data_ptr
 144     _M_get_thread_data() const
 145     {
 146       lock_guard<mutex> __l(_M_thread_data_mutex);
 147       return _M_thread_data;
 148     }
 149
 150   private:
 151     template<typename _Callable>
 152       __thread_data_ptr
 153       __make_thread_data(_Callable&& __f)
 154       {
 155         return __thread_data_ptr(
 156           new __thread_data<_Callable>(std::forward<_Callable>(__f)));
 157       }
 158
 159     __thread_data_ptr
 160     __make_thread_data(void(*__f)())
 161     { return __thread_data_ptr(new __thread_data<void(*)()>(__f)); }
 162
 163     void __start_thread();
 164
 165     __thread_data_ptr   _M_thread_data;
 166     mutable mutex       _M_thread_data_mutex;
 167   };
 168
 169   inline void
 170   swap(thread& __x, thread& __y)
 171   { __x.swap(__y); }
 172
 173   inline void
 174   swap(thread&& __x, thread& __y)
 175   { __x.swap(__y); }
 176
 177   inline void
 178   swap(thread& __x, thread&& __y)
 179   { __x.swap(__y); }
 180
 181   namespace this_thread
 182   {
 183     thread::id
 184     get_id();
 185
 186 #ifdef _GLIBCXX_USE_SCHED_YIELD
 187     inline void
 188     yield()
 189     { __gthread_yield(); }
 190 #endif
 191
 192 #ifdef _GLIBCXX_USE_NANOSLEEP
 193     template<typename _Clock, typename _Duration>
 194       inline void
 195       sleep_until(const chrono::time_point<_Clock, _Duration>& __atime)
 196       { sleep_for(__atime - _Clock::now()); }
 197
 198     template<typename _Rep, typename _Period>
 199       inline void
 200       sleep_for(const chrono::duration<_Rep, _Period>& __rtime)
 201       {
 202         chrono::seconds __s =
 203           chrono::duration_cast<chrono::seconds>(__rtime);
 204
 205         chrono::nanoseconds __ns =
 206           chrono::duration_cast<chrono::nanoseconds>(__rtime - __s);
 207
 208         __gthread_time_t __ts =
 209           {
 210             static_cast<std::time_t>(__s.count()),
 211             static_cast<long>(__ns.count())
 212           };
 213
 214         ::nanosleep(&__ts, 0);
 215       }
 216 #endif
 217   }
 218
 219   /// thread::id
 220   class thread::id
 221   {
 222   public:
 223     id() : _M_thread_id() { }
 224
 225   private:
 226     friend class thread;
 227
 228     friend thread::id this_thread::get_id();
 229
 230     friend bool
 231     operator==(thread::id __x, thread::id __y)
 232     { return static_cast<bool>(__gthread_equal(__x._M_thread_id,
 233                                                __y._M_thread_id)); }
 234
 235     friend bool
 236     operator<(thread::id __x, thread::id __y)
 237     { return __x._M_thread_id < __y._M_thread_id; }
 238
 239     template<class _CharT, class _Traits>
 240       friend basic_ostream<_CharT, _Traits>&
 241       operator<<(basic_ostream<_CharT, _Traits>&& __out, thread::id __id);
 242
 243     id(__gthread_t __id)
 244     : _M_thread_id(__id)
 245     { }
 246
 247     __gthread_t _M_thread_id;
 248   };
 249
 250   inline bool
 251   operator!=(thread::id __x, thread::id __y)
 252   { return !(__x == __y); }
 253
 254   inline bool
 255   operator<=(thread::id __x, thread::id __y)
 256   { return !(__y < __x); }
 257
 258   inline bool
 259   operator>(thread::id __x, thread::id __y)
 260   { return __y < __x; }
 261
 262   inline bool
 263   operator>=(thread::id __x, thread::id __y)
 264   { return !(__x < __y); }
 265
 266   template<class _CharT, class _Traits>
 267     inline basic_ostream<_CharT, _Traits>&
 268     operator<<(basic_ostream<_CharT, _Traits>&& __out, thread::id __id)
 269     {
 270       if(__id == thread::id())
 271         return __out << "non-executing thread";
 272       else
 273         return __out << __id._M_thread_id;
 274     }
 275
 276   inline bool
 277   thread::joinable() const
 278   { return get_id() != thread::id(); }
 279
 280   inline thread::id
 281   thread::get_id() const
 282   {
 283     if(_M_thread_data)
 284       return thread::id(_M_thread_data->_M_thread_handle);
 285     else
 286       return thread::id();
 287   }
 288
 289   namespace this_thread
 290   {
 291     inline thread::id
 292     get_id()
 293     { return thread::id(__gthread_self()); }
 294   }
 295 }
 296
 297 #endif // _GLIBCXX_HAS_GTHREADS && _GLIBCXX_USE_C99_STDINT_TR1
 298
 299 #endif // __GXX_EXPERIMENTAL_CXX0X__
 300
 301 #endif // _GLIBCXX_THREAD