[v2,11/11] shared_mutex: Fix try_lock_until and try_lock_shared_until on arbitrary clock

Message ID 742e8a476d37a7dab42c9b79136bcc89db130d63.1571162241.git-series.mac@mcrowe.com
State New
Headers show
Series
  • timed_mutex, shared_timed_mutex: Add full steady clock support
Related show

Commit Message

Mike Crowe Oct. 15, 2019, 5:57 p.m.
This is the equivalent to PR libstdc++/91906, but for shared_mutex.

A non-standard clock may tick more slowly than std::chrono::steady_clock.
This means that we risk returning false early when the specified timeout
may not have expired. This can be avoided by looping until the timeout time
as reported by the non-standard clock has been reached.

Unfortunately, we have no way to tell whether the non-standard clock ticks
more quickly that std::chrono::steady_clock. If it does then we risk
returning later than would be expected, but that is unavoidable without
waking up periodically to check, which would be rather too expensive.

Fran├žois Dumont pointed out[1] a flaw in an earlier version of this patch
that revealed a hole in the test coverage, so I've added a new test that
try_lock_until acts as try_lock if the timeout has already expired.

[1] https://gcc.gnu.org/ml/libstdc++/2019-10/msg00021.html

	* include/std/shared_mutex (try_lock_until, try_lock_shared_until):
	Loop until the absolute timeout time is reached as measured against
	the appropriate clock.
	* testsuite/30_threads/shared_mutex/try_lock_until/1.cc: New
	file. Test shared_mutex::try_lock_until and
	shared_mutex::try_lock_shared_until timeouts against various
	clocks.
	* testsuite/30_threads/shared_mutex/try_lock_until/1.cc: New
	file. Test shared_mutex::try_lock_until and
	shared_mutex::try_lock_shared_until timeouts against various
	clocks.
---
 libstdc++-v3/include/std/shared_mutex                                    | 28 ++++++++++++++++++-----
 libstdc++-v3/testsuite/30_threads/shared_timed_mutex/try_lock_until/1.cc | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 libstdc++-v3/testsuite/30_threads/shared_timed_mutex/try_lock_until/2.cc | 75 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 3 files changed, 184 insertions(+), 6 deletions(-)
 create mode 100644 libstdc++-v3/testsuite/30_threads/shared_timed_mutex/try_lock_until/1.cc
 create mode 100644 libstdc++-v3/testsuite/30_threads/shared_timed_mutex/try_lock_until/2.cc

-- 
git-series 0.9.1

Patch

diff --git a/libstdc++-v3/include/std/shared_mutex b/libstdc++-v3/include/std/shared_mutex
index 6e67324..841f18b 100644
--- a/libstdc++-v3/include/std/shared_mutex
+++ b/libstdc++-v3/include/std/shared_mutex
@@ -554,9 +554,17 @@  _GLIBCXX_BEGIN_NAMESPACE_VERSION
       bool
       try_lock_until(const chrono::time_point<_Clock, _Duration>& __atime)
       {
-        typename _Clock::time_point __now = _Clock::now();
-        auto __rtime = __atime - __now;
-        return try_lock_for(__rtime);
+        // The user-supplied clock may not tick at the same rate as
+        // steady_clock, so we must loop in order to guarantee that
+        // the timeout has expired before returning false.
+	typename _Clock::time_point __now = _Clock::now();
+        do {
+          auto __rtime = __atime - __now;
+          if (try_lock_for(__rtime))
+            return true;
+          __now = _Clock::now();
+        } while (__atime > __now);
+        return false;
       }
 
     // Shared ownership
@@ -631,9 +639,17 @@  _GLIBCXX_BEGIN_NAMESPACE_VERSION
       try_lock_shared_until(const chrono::time_point<_Clock,
 						     _Duration>& __atime)
       {
-        typename _Clock::time_point __now = _Clock::now();
-        auto __rtime = __atime - __now;
-        return try_lock_shared_for(__rtime);
+        // The user-supplied clock may not tick at the same rate as
+        // steady_clock, so we must loop in order to guarantee that
+        // the timeout has expired before returning false.
+	typename _Clock::time_point __now = _Clock::now();
+        do {
+          auto __rtime = __atime - __now;
+          if (try_lock_shared_for(__rtime))
+            return true;
+          __now = _Clock::now();
+        } while (__atime > __now);
+        return false;
       }
 
 #else // ! (_GLIBCXX_USE_PTHREAD_RWLOCK_T && _GTHREAD_USE_MUTEX_TIMEDLOCK)
diff --git a/libstdc++-v3/testsuite/30_threads/shared_timed_mutex/try_lock_until/1.cc b/libstdc++-v3/testsuite/30_threads/shared_timed_mutex/try_lock_until/1.cc
new file mode 100644
index 0000000..a0ab536
--- /dev/null
+++ b/libstdc++-v3/testsuite/30_threads/shared_timed_mutex/try_lock_until/1.cc
@@ -0,0 +1,87 @@ 
+// { dg-do run }
+// { dg-options "-pthread"  }
+// { dg-require-effective-target c++14 }
+// { dg-require-effective-target pthread }
+// { dg-require-gthreads "" }
+
+// Copyright (C) 2019 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 3, or (at your option)
+// any later version.
+
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// 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 COPYING3.  If not see
+// <http://www.gnu.org/licenses/>.
+
+
+#include <shared_mutex>
+#include <thread>
+#include <system_error>
+#include <testsuite_hooks.h>
+#include <slow_clock.h>
+
+template <typename clock_type>
+void test()
+{
+  typedef std::shared_timed_mutex mutex_type;
+
+  try
+    {
+      mutex_type m;
+      m.lock();
+      bool b;
+
+      std::thread t([&] {
+        try
+          {
+            using namespace std::chrono;
+            const auto timeout = 100ms;
+
+	    {
+	      const auto start = clock_type::now();
+	      const auto b = m.try_lock_until(start + timeout);
+	      const auto t = clock_type::now() - start;
+	      VERIFY( !b );
+	      VERIFY( t >= timeout );
+	    }
+
+	    {
+	      const auto start = clock_type::now();
+	      const auto b = m.try_lock_shared_until(start + timeout);
+	      const auto t = clock_type::now() - start;
+	      VERIFY( !b );
+	      VERIFY( t >= timeout );
+	    }
+          }
+        catch (const std::system_error& e)
+          {
+            VERIFY( false );
+          }
+	});
+      t.join();
+      m.unlock();
+    }
+  catch (const std::system_error& e)
+    {
+      VERIFY( false );
+    }
+  catch (...)
+    {
+      VERIFY( false );
+    }
+}
+
+int main()
+{
+  test<std::chrono::system_clock>();
+  test<std::chrono::steady_clock>();
+  test<slow_clock>();
+}
diff --git a/libstdc++-v3/testsuite/30_threads/shared_timed_mutex/try_lock_until/2.cc b/libstdc++-v3/testsuite/30_threads/shared_timed_mutex/try_lock_until/2.cc
new file mode 100644
index 0000000..0fdbb77
--- /dev/null
+++ b/libstdc++-v3/testsuite/30_threads/shared_timed_mutex/try_lock_until/2.cc
@@ -0,0 +1,75 @@ 
+// { dg-do run }
+// { dg-options "-pthread"  }
+// { dg-require-effective-target c++14 }
+// { dg-require-effective-target pthread }
+// { dg-require-gthreads "" }
+
+// Copyright (C) 2019 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 3, or (at your option)
+// any later version.
+
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// 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 COPYING3.  If not see
+// <http://www.gnu.org/licenses/>.
+
+
+#include <shared_mutex>
+#include <system_error>
+#include <testsuite_hooks.h>
+#include <slow_clock.h>
+
+template <typename clock_type>
+void test()
+{
+  typedef std::shared_timed_mutex mutex_type;
+
+  try
+    {
+      using namespace std::chrono;
+      mutex_type m;
+
+      // Confirm that try_lock_until acts like try_lock if the timeout has
+      // already passed.
+
+      // First test unique lock with a timeout that is definitely in the past.
+      VERIFY( m.try_lock_until( clock_type::now() - 1s ) );
+      m.unlock();
+
+      // Then attempt to test unique lock with a timeout that might exactly
+      // match the current time.
+      VERIFY( m.try_lock_until( clock_type::now() ) );
+      m.unlock();
+
+      // Now do the same but with the shared lock
+      VERIFY( m.try_lock_shared_until( clock_type::now() - 1s ) );
+      m.unlock();
+
+      VERIFY( m.try_lock_shared_until( clock_type::now() ) );
+      m.unlock();
+
+    }
+  catch (const std::system_error& e)
+    {
+      VERIFY( false );
+    }
+  catch (...)
+    {
+      VERIFY( false );
+    }
+}
+
+int main()
+{
+  test<std::chrono::system_clock>();
+  test<std::chrono::steady_clock>();
+  test<slow_clock>();
+}