OSDN Git Service

* src/condition_variable.cc (condition_variable,
[pf3gnuchains/gcc-fork.git] / libstdc++-v3 / include / std / mutex
index e4ceaf2..f26acc0 100644 (file)
@@ -1,12 +1,12 @@
 // <mutex> -*- C++ -*-
 
-// Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008
+// Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009
 // 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.
+// 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.
 
-// 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.
+// 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 mutex
  *  This is a Standard C++ Library header.
@@ -41,6 +36,7 @@
 # include <c++0x_warning.h>
 #else
 
+#include <tuple>
 #include <cstddef>
 #include <chrono>
 #include <exception>
 
 namespace std
 {
+  /**
+   * @defgroup mutexes Mutexes
+   * @ingroup concurrency
+   *
+   * Classes for mutex support.
+   * @{
+   */
+
   /// mutex
   class mutex
   {
+    typedef __gthread_mutex_t                  __native_type;
+    __native_type  _M_mutex;
+
   public:
-    typedef __gthread_mutex_t* native_handle_type;
+    typedef __native_type*                     native_handle_type;
 
     mutex()
     {
       // XXX EAGAIN, ENOMEM, EPERM, EBUSY(may), EINVAL(may)
 #ifdef __GTHREAD_MUTEX_INIT
-      __gthread_mutex_t __tmp = __GTHREAD_MUTEX_INIT;
+      __native_type __tmp = __GTHREAD_MUTEX_INIT;
       _M_mutex = __tmp;
 #else
       __GTHREAD_MUTEX_INIT_FUNCTION(&_M_mutex);
@@ -102,22 +109,22 @@ namespace std
     native_handle_type
     native_handle()
     { return &_M_mutex; }
-
-  private:
-    __gthread_mutex_t _M_mutex;
   };
 
   /// recursive_mutex
   class recursive_mutex
   {
+    typedef __gthread_recursive_mutex_t                __native_type;
+    __native_type  _M_mutex;
+
   public:
-    typedef __gthread_recursive_mutex_t* native_handle_type;
+    typedef __native_type*                     native_handle_type;
 
     recursive_mutex()
     {
       // XXX EAGAIN, ENOMEM, EPERM, EBUSY(may), EINVAL(may)
 #ifdef __GTHREAD_RECURSIVE_MUTEX_INIT
-      __gthread_recursive_mutex_t __tmp = __GTHREAD_RECURSIVE_MUTEX_INIT;
+      __native_type __tmp = __GTHREAD_RECURSIVE_MUTEX_INIT;
       _M_mutex = __tmp;
 #else
       __GTHREAD_RECURSIVE_MUTEX_INIT_FUNCTION(&_M_mutex);
@@ -154,21 +161,28 @@ namespace std
     native_handle_type
     native_handle()
     { return &_M_mutex; }
-
-  private:
-    __gthread_recursive_mutex_t  _M_mutex;
   };
 
   /// timed_mutex
   class timed_mutex
-  {  
+  {
+    typedef __gthread_mutex_t                  __native_type;
+
+#ifdef _GLIBCXX_USE_CLOCK_MONOTONIC
+    typedef chrono::monotonic_clock            __clock_t;
+#else
+    typedef chrono::high_resolution_clock      __clock_t;
+#endif
+
+    __native_type  _M_mutex;
+
   public:
-    typedef __gthread_mutex_t* native_handle_type;
+    typedef __native_type*                     native_handle_type;
 
     timed_mutex()
     {
 #ifdef __GTHREAD_MUTEX_INIT
-      __gthread_mutex_t __tmp = __GTHREAD_MUTEX_INIT;
+      __native_type __tmp = __GTHREAD_MUTEX_INIT;
       _M_mutex = __tmp;
 #else
       __GTHREAD_MUTEX_INIT_FUNCTION(&_M_mutex);
@@ -203,19 +217,19 @@ namespace std
     template <class _Clock, class _Duration>
       bool
       try_lock_until(const chrono::time_point<_Clock, _Duration>& __atime)
-      { 
+      {
        chrono::time_point<_Clock, chrono::seconds> __s =
-          chrono::time_point_cast<chrono::seconds>(__atime);
+         chrono::time_point_cast<chrono::seconds>(__atime);
 
        chrono::nanoseconds __ns =
-          chrono::duration_cast<chrono::nanoseconds>(__atime - __s);
+         chrono::duration_cast<chrono::nanoseconds>(__atime - __s);
 
-        __gthread_time_t __ts = {
-          static_cast<std::time_t>(__s.time_since_epoch().count()),
-          static_cast<long>(__ns.count())
-        };
+       __gthread_time_t __ts = {
+         static_cast<std::time_t>(__s.time_since_epoch().count()),
+         static_cast<long>(__ns.count())
+       };
 
-       return !__gthread_mutex_timedlock(&_M_mutex, &__ts);    
+       return !__gthread_mutex_timedlock(&_M_mutex, &__ts);
       }
 
     void
@@ -228,50 +242,52 @@ namespace std
     native_handle_type
     native_handle()
     { return &_M_mutex; }
-    
-  private:
-    __gthread_mutex_t _M_mutex;
-    
-#ifdef _GLIBCXX_USE_CLOCK_MONOTONIC
-    typedef chrono::monotonic_clock __clock_t;
-#else
-    typedef chrono::high_resolution_clock __clock_t;
-#endif
 
+  private:
     template<typename _Rep, typename _Period>
       typename enable_if<
-        ratio_less_equal<__clock_t::period, _Period>::value, bool>::type
+       ratio_less_equal<__clock_t::period, _Period>::value, bool>::type
       __try_lock_for_impl(const chrono::duration<_Rep, _Period>& __rtime)
       {
-        __clock_t::time_point __atime = __clock_t::now()
-          + chrono::duration_cast<__clock_t::duration>(__rtime);
+       __clock_t::time_point __atime = __clock_t::now()
+         + chrono::duration_cast<__clock_t::duration>(__rtime);
 
-        return try_lock_until(__atime);
+       return try_lock_until(__atime);
       }
 
     template <typename _Rep, typename _Period>
       typename enable_if<
-        !ratio_less_equal<__clock_t::period, _Period>::value, bool>::type
+       !ratio_less_equal<__clock_t::period, _Period>::value, bool>::type
       __try_lock_for_impl(const chrono::duration<_Rep, _Period>& __rtime)
       {
-        __clock_t::time_point __atime = __clock_t::now()
+       __clock_t::time_point __atime = __clock_t::now()
          + ++chrono::duration_cast<__clock_t::duration>(__rtime);
 
-        return try_lock_until(__atime);
+       return try_lock_until(__atime);
       }
   };
 
   /// recursive_timed_mutex
   class recursive_timed_mutex
   {
+    typedef __gthread_recursive_mutex_t                __native_type;
+
+#ifdef _GLIBCXX_USE_CLOCK_MONOTONIC
+    typedef chrono::monotonic_clock            __clock_t;
+#else
+    typedef chrono::high_resolution_clock      __clock_t;
+#endif
+
+    __native_type  _M_mutex;
+
   public:
-    typedef __gthread_recursive_mutex_t* native_handle_type;
+    typedef __native_type*                     native_handle_type;
 
     recursive_timed_mutex()
     {
       // XXX EAGAIN, ENOMEM, EPERM, EBUSY(may), EINVAL(may)
 #ifdef __GTHREAD_RECURSIVE_MUTEX_INIT
-      __gthread_recursive_mutex_t __tmp = __GTHREAD_RECURSIVE_MUTEX_INIT;
+      __native_type __tmp = __GTHREAD_RECURSIVE_MUTEX_INIT;
       _M_mutex = __tmp;
 #else
       __GTHREAD_RECURSIVE_MUTEX_INIT_FUNCTION(&_M_mutex);
@@ -306,19 +322,19 @@ namespace std
     template <class _Clock, class _Duration>
       bool
       try_lock_until(const chrono::time_point<_Clock, _Duration>& __atime)
-      { 
+      {
        chrono::time_point<_Clock, chrono::seconds>  __s =
-          chrono::time_point_cast<chrono::seconds>(__atime);
+         chrono::time_point_cast<chrono::seconds>(__atime);
 
        chrono::nanoseconds __ns =
-          chrono::duration_cast<chrono::nanoseconds>(__atime - __s);
+         chrono::duration_cast<chrono::nanoseconds>(__atime - __s);
 
-        __gthread_time_t __ts = {
-          static_cast<std::time_t>(__s.time_since_epoch().count()),
-          static_cast<long>(__ns.count())
-        };
+       __gthread_time_t __ts = {
+         static_cast<std::time_t>(__s.time_since_epoch().count()),
+         static_cast<long>(__ns.count())
+       };
 
-        return !__gthread_recursive_mutex_timedlock(&_M_mutex, &__ts);
+       return !__gthread_recursive_mutex_timedlock(&_M_mutex, &__ts);
       }
 
     void
@@ -333,34 +349,26 @@ namespace std
     { return &_M_mutex; }
 
   private:
-    __gthread_recursive_mutex_t _M_mutex;
-
-#ifdef _GLIBCXX_USE_CLOCK_MONOTONIC
-    typedef chrono::monotonic_clock __clock_t;
-#else
-    typedef chrono::high_resolution_clock __clock_t;
-#endif
-
     template<typename _Rep, typename _Period>
       typename enable_if<
-        ratio_less_equal<__clock_t::period, _Period>::value, bool>::type
+       ratio_less_equal<__clock_t::period, _Period>::value, bool>::type
       __try_lock_for_impl(const chrono::duration<_Rep, _Period>& __rtime)
       {
-        __clock_t::time_point __atime = __clock_t::now()
-          + chrono::duration_cast<__clock_t::duration>(__rtime);
+       __clock_t::time_point __atime = __clock_t::now()
+         + chrono::duration_cast<__clock_t::duration>(__rtime);
 
-        return try_lock_until(__atime);
+       return try_lock_until(__atime);
       }
 
     template <typename _Rep, typename _Period>
       typename enable_if<
-        !ratio_less_equal<__clock_t::period, _Period>::value, bool>::type
+       !ratio_less_equal<__clock_t::period, _Period>::value, bool>::type
       __try_lock_for_impl(const chrono::duration<_Rep, _Period>& __rtime)
       {
-        __clock_t::time_point __atime = __clock_t::now()
+       __clock_t::time_point __atime = __clock_t::now()
          + ++chrono::duration_cast<__clock_t::duration>(__rtime);
 
-        return try_lock_until(__atime);
+       return try_lock_until(__atime);
       }
   };
 
@@ -378,12 +386,16 @@ namespace std
   extern const try_to_lock_t   try_to_lock;
   extern const adopt_lock_t    adopt_lock;
 
-  /// Thrown to indicate errors with lock operations.
+  /** 
+   *  @brief Thrown to indicate errors with lock operations.
+   *
+   *  @ingroup exceptions
+   */
   class lock_error : public exception
   {
   public:
     virtual const char*
-    what() const throw();
+    _GLIBCXX_CONST what() const throw();
   };
 
   /// @brief  Scoped lock idiom.
@@ -417,7 +429,7 @@ namespace std
     {
     public:
       typedef _Mutex mutex_type;
-      
+
       unique_lock()
       : _M_device(0), _M_owns(false)
       { }
@@ -444,13 +456,13 @@ namespace std
       }
 
       template<typename _Clock, typename _Duration>
-       unique_lock(mutex_type& __m, 
+       unique_lock(mutex_type& __m,
                    const chrono::time_point<_Clock, _Duration>& __atime)
        : _M_device(&__m), _M_owns(_M_device->try_lock_until(__atime))
        { }
 
       template<typename _Rep, typename _Period>
-       unique_lock(mutex_type& __m, 
+       unique_lock(mutex_type& __m,
                    const chrono::duration<_Rep, _Period>& __rtime)
        : _M_device(&__m), _M_owns(_M_device->try_lock_for(__rtime))
        { }
@@ -473,14 +485,14 @@ namespace std
 
       unique_lock& operator=(unique_lock&& __u)
       {
-        if(_M_owns)
+       if(_M_owns)
          unlock();
-       
+
        unique_lock(std::move(__u)).swap(*this);
 
        __u._M_device = 0;
        __u._M_owns = false;
-       
+
        return *this;
       }
 
@@ -488,9 +500,9 @@ namespace std
       lock()
       {
        if (!_M_device)
-         __throw_system_error(posix_error::operation_not_permitted);
+         __throw_system_error(int(errc::operation_not_permitted));
        else if (_M_owns)
-         __throw_system_error(posix_error::resource_deadlock_would_occur);
+         __throw_system_error(int(errc::resource_deadlock_would_occur));
        else
          {
            _M_device->lock();
@@ -502,39 +514,39 @@ namespace std
       try_lock()
       {
        if (!_M_device)
-          __throw_system_error(posix_error::operation_not_permitted);
-        else if (_M_owns)
-          __throw_system_error(posix_error::resource_deadlock_would_occur);
-        else
+         __throw_system_error(int(errc::operation_not_permitted));
+       else if (_M_owns)
+         __throw_system_error(int(errc::resource_deadlock_would_occur));
+       else
          {
-           _M_owns = _M_device->try_lock();        
+           _M_owns = _M_device->try_lock();
            return _M_owns;
          }
       }
 
       template<typename _Clock, typename _Duration>
-        bool
-        try_lock_until(const chrono::time_point<_Clock, _Duration>& __atime)
-        {
+       bool
+       try_lock_until(const chrono::time_point<_Clock, _Duration>& __atime)
+       {
          if (!_M_device)
-           __throw_system_error(posix_error::operation_not_permitted);
+           __throw_system_error(int(errc::operation_not_permitted));
          else if (_M_owns)
-           __throw_system_error(posix_error::resource_deadlock_would_occur);
+           __throw_system_error(int(errc::resource_deadlock_would_occur));
          else
            {
              _M_owns = _M_device->try_lock_until(__atime);
              return _M_owns;
            }
        }
-      
+
       template<typename _Rep, typename _Period>
        bool
        try_lock_for(const chrono::duration<_Rep, _Period>& __rtime)
-        {
+       {
          if (!_M_device)
-           __throw_system_error(posix_error::operation_not_permitted);
+           __throw_system_error(int(errc::operation_not_permitted));
          else if (_M_owns)
-           __throw_system_error(posix_error::resource_deadlock_would_occur);
+           __throw_system_error(int(errc::resource_deadlock_would_occur));
          else
            {
              _M_owns = _M_device->try_lock_for(__rtime);
@@ -545,15 +557,15 @@ namespace std
       void
       unlock()
       {
-        if (!_M_owns)
-          __throw_system_error(posix_error::operation_not_permitted);
-        else if (_M_device)
-          {
-            _M_device->unlock();
-            _M_owns = false;
-          }
+       if (!_M_owns)
+         __throw_system_error(int(errc::operation_not_permitted));
+       else if (_M_device)
+         {
+           _M_device->unlock();
+           _M_owns = false;
+         }
       }
-      
+
       void
       swap(unique_lock&& __u)
       {
@@ -601,10 +613,83 @@ namespace std
     swap(unique_lock<_Mutex>& __x, unique_lock<_Mutex>&& __y)
     { __x.swap(__y); }
 
-  template<typename _L1, typename _L2, typename ..._L3>
+  template<int _Idx>
+    struct __unlock_impl
+    {
+      template<typename... _Lock>
+       static void
+       __do_unlock(tuple<_Lock&...>& __locks)
+       {
+         std::get<_Idx>(__locks).unlock();
+         __unlock_impl<_Idx - 1>::__do_unlock(__locks);
+       }
+    };
+
+  template<>
+    struct __unlock_impl<-1>
+    {
+      template<typename... _Lock>
+       static void
+       __do_unlock(tuple<_Lock&...>&)
+       { }
+    };
+
+  template<int _Idx, bool _Continue = true>
+    struct __try_lock_impl
+    {
+      template<typename... _Lock>
+       static int
+       __do_try_lock(tuple<_Lock&...>& __locks)
+       {
+         if(std::get<_Idx>(__locks).try_lock())
+           {
+             return __try_lock_impl<_Idx + 1,
+               _Idx + 2 < sizeof...(_Lock)>::__do_try_lock(__locks);
+           }
+         else
+           {
+             __unlock_impl<_Idx>::__do_unlock(__locks);
+             return _Idx;
+           }
+       }
+    };
+
+  template<int _Idx>
+    struct __try_lock_impl<_Idx, false>
+    {
+      template<typename... _Lock>
+       static int
+       __do_try_lock(tuple<_Lock&...>& __locks)
+       {
+         if(std::get<_Idx>(__locks).try_lock())
+           return -1;
+         else
+           {
+             __unlock_impl<_Idx>::__do_unlock(__locks);
+             return _Idx;
+           }
+       }
+    };
+
+  /** @brief Generic try_lock.
+   *  @param __l1 Meets Mutex requirements (try_lock() may throw).
+   *  @param __l2 Meets Mutex requirements (try_lock() may throw).
+   *  @param __l3 Meets Mutex requirements (try_lock() may throw).
+   *  @return Returns -1 if all try_lock() calls return true. Otherwise returns
+   *          a 0-based index corresponding to the argument that returned false.
+   *  @post Either all arguments are locked, or none will be.
+   *
+   *  Sequentially calls try_lock() on each argument.
+   */
+  template<typename _Lock1, typename _Lock2, typename... _Lock3>
     int
-    try_lock(_L1& __l1, _L2& __l2, _L3&... __l3);
+    try_lock(_Lock1& __l1, _Lock2& __l2, _Lock3&... __l3)
+    {
+      tuple<_Lock1&, _Lock2&, _Lock3&...> __locks(__l1, __l2, __l3...);
+      return __try_lock_impl<0>::__do_try_lock(__locks);
+    }
 
+  /// lock
   template<typename _L1, typename _L2, typename ..._L3>
     void
     lock(_L1&, _L2&, _L3&...);
@@ -612,23 +697,23 @@ namespace std
   /// once_flag
   struct once_flag
   {
+  private:
     typedef __gthread_once_t __native_type;
+    __native_type  _M_once;
 
+  public:
     once_flag()
     {
-      __gthread_once_t __tmp = __GTHREAD_ONCE_INIT;
+      __native_type __tmp = __GTHREAD_ONCE_INIT;
       _M_once = __tmp;
     }
-    
+
     once_flag(const once_flag&) = delete;
     once_flag& operator=(const once_flag&) = delete;
 
     template<typename _Callable, typename... _Args>
       friend void
       call_once(once_flag& __once, _Callable __f, _Args&&... __args);
-
-  private:
-    __native_type  _M_once;
   };
 
 #ifdef _GLIBCXX_HAVE_TLS
@@ -636,17 +721,21 @@ namespace std
   extern __thread void (*__once_call)();
 
   template<typename _Callable>
-    void __once_call_impl()
+    inline void
+    __once_call_impl()
     {
       (*(_Callable*)__once_callable)();
     }
 #else
   extern function<void()> __once_functor;
-  extern unique_lock<mutex> __once_functor_lock;
+
+  extern unique_lock<mutex>&
+  __get_once_functor_lock();
 #endif
 
   extern "C" void __once_proxy();
 
+  /// call_once
   template<typename _Callable, typename... _Args>
     void
     call_once(once_flag& __once, _Callable __f, _Args&&... __args)
@@ -656,20 +745,23 @@ namespace std
       __once_callable = &__bound_functor;
       __once_call = &__once_call_impl<decltype(__bound_functor)>;
 #else
-      __once_functor_lock.lock();
+      unique_lock<mutex>& __functor_lock = __get_once_functor_lock();
+      __functor_lock.lock();
       __once_functor = bind(__f, __args...);
 #endif
-     
+
       int __e = __gthread_once(&(__once._M_once), &__once_proxy);
 
-#ifndef _GLIBCXX_HAVE_TLS      
-      if (__once_functor_lock)
-       __once_functor_lock.unlock();
+#ifndef _GLIBCXX_HAVE_TLS
+      if (__functor_lock)
+       __functor_lock.unlock();
 #endif
 
       if (__e)
        __throw_system_error(__e);
     }
+
+  // @} group mutexes
 }
 
 #endif // _GLIBCXX_HAS_GTHREADS && _GLIBCXX_USE_C99_STDINT_TR1