1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
|
/*
* Copyright © Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 or 3,
* as published by the Free Software Foundation.
*
* This program 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 program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "mir/recursive_read_write_mutex.h"
#include "mir/test/barrier.h"
#include <gtest/gtest.h>
#include <gmock/gmock.h>
namespace mt = mir::test;
using namespace testing;
namespace
{
/* These tests are not ideal as they may fail by hanging. But I don't know a good
* way to kill a thread within the process (i.e. without leaking resources and
* causing "undefined behavior"). That is having a "watchdog" timeout just leads
* to other issues and running in a separate process seems OTT.
*/
struct RecursiveReadWriteMutex : public Test
{
int const recursion_depth{1729};
unsigned const reader_threads{42};
mt::Barrier readonly_barrier{reader_threads};
mt::Barrier read_and_write_barrier{reader_threads+1};
std::vector<std::thread> threads;
mir::RecursiveReadWriteMutex mutex;
void SetUp()
{
threads.reserve(reader_threads+1);
}
void TearDown()
{
for (auto& thread : threads)
if (thread.joinable()) thread.join();
}
MOCK_METHOD0(notify_read_locked, void());
MOCK_METHOD0(notify_read_unlocking, void());
MOCK_METHOD0(notify_write_locked, void());
MOCK_METHOD0(notify_write_unlocking, void());
};
}
TEST_F(RecursiveReadWriteMutex, can_be_recursively_read_locked)
{
for (int i = 0; i != recursion_depth; ++i)
mutex.read_lock();
}
TEST_F(RecursiveReadWriteMutex, can_be_recursively_write_locked)
{
for (int i = 0; i != recursion_depth; ++i)
mutex.write_lock();
}
TEST_F(RecursiveReadWriteMutex, can_be_write_locked_on_thread_with_read_lock)
{
mutex.read_lock();
mutex.write_lock();
}
TEST_F(RecursiveReadWriteMutex, can_be_read_locked_on_thread_with_write_lock)
{
mutex.write_lock();
mutex.read_lock();
}
TEST_F(RecursiveReadWriteMutex, can_be_read_locked_on_multiple_threads)
{
auto const reader_function =
[&]{
mutex.read_lock();
notify_read_locked();
readonly_barrier.ready();
notify_read_unlocking();
mutex.read_unlock();
};
InSequence seq;
EXPECT_CALL(*this, notify_read_locked()).Times(reader_threads);
EXPECT_CALL(*this, notify_read_unlocking()).Times(reader_threads);
for (auto i = 0U; i != reader_threads; ++i)
threads.push_back(std::thread{reader_function});
}
TEST_F(RecursiveReadWriteMutex, write_lock_waits_for_read_locks_on_other_threads)
{
auto const reader_function =
[&]{
mutex.read_lock();
notify_read_locked();
read_and_write_barrier.ready();
notify_read_unlocking();
mutex.read_unlock();
};
auto const writer_function =
[&]{
read_and_write_barrier.ready();
mutex.write_lock();
notify_write_locked();
};
InSequence seq;
EXPECT_CALL(*this, notify_read_locked()).Times(reader_threads);
EXPECT_CALL(*this, notify_read_unlocking()).Times(reader_threads);
EXPECT_CALL(*this, notify_write_locked()).Times(1);
for (auto i = 0U; i != reader_threads; ++i)
threads.push_back(std::thread{reader_function});
threads.push_back(std::thread{writer_function});
}
TEST_F(RecursiveReadWriteMutex, read_lock_waits_for_write_locks_on_other_threads)
{
auto const reader_function =
[&]{
read_and_write_barrier.ready();
mutex.read_lock();
notify_read_locked();
};
auto const writer_function =
[&]{
mutex.write_lock();
notify_write_locked();
read_and_write_barrier.ready();
notify_write_unlocking();
mutex.write_unlock();
};
InSequence seq;
EXPECT_CALL(*this, notify_write_locked()).Times(1);
EXPECT_CALL(*this, notify_write_unlocking()).Times(1);
EXPECT_CALL(*this, notify_read_locked()).Times(reader_threads);
for (auto i = 0U; i != reader_threads; ++i)
threads.push_back(std::thread{reader_function});
threads.push_back(std::thread{writer_function});
}
|