summaryrefslogtreecommitdiffstats
path: root/third_party/mojo/src/mojo/edk/system/mutex_unittest.cc
blob: bcd745a0ba0913fd798650f360543b66371e88e3 (plain)
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "third_party/mojo/src/mojo/edk/system/mutex.h"

#include <stdlib.h>

#include "base/threading/platform_thread.h"
#include "mojo/public/cpp/system/macros.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/mojo/src/mojo/edk/system/test_utils.h"

namespace mojo {
namespace system {
namespace {

// Sleeps for a "very small" amount of time.
void EpsilonRandomSleep() {
  test::Sleep(test::DeadlineFromMilliseconds(rand() % 20));
}

// Basic test to make sure that Lock()/Unlock()/TryLock() don't crash ----------

class BasicMutexTestThread : public base::PlatformThread::Delegate {
 public:
  explicit BasicMutexTestThread(Mutex* mutex) : mutex_(mutex), acquired_(0) {}

  void ThreadMain() override {
    for (int i = 0; i < 10; i++) {
      mutex_->Lock();
      mutex_->AssertHeld();
      acquired_++;
      mutex_->Unlock();
    }
    for (int i = 0; i < 10; i++) {
      mutex_->Lock();
      mutex_->AssertHeld();
      acquired_++;
      EpsilonRandomSleep();
      mutex_->Unlock();
    }
    for (int i = 0; i < 10; i++) {
      if (mutex_->TryLock()) {
        mutex_->AssertHeld();
        acquired_++;
        EpsilonRandomSleep();
        mutex_->Unlock();
      }
    }
  }

  int acquired() const { return acquired_; }

 private:
  Mutex* mutex_;
  int acquired_;

  MOJO_DISALLOW_COPY_AND_ASSIGN(BasicMutexTestThread);
};

TEST(MutexTest, Basic) {
  Mutex mutex;
  BasicMutexTestThread thread(&mutex);
  base::PlatformThreadHandle handle;

  ASSERT_TRUE(base::PlatformThread::Create(0, &thread, &handle));

  int acquired = 0;
  for (int i = 0; i < 5; i++) {
    mutex.Lock();
    mutex.AssertHeld();
    acquired++;
    mutex.Unlock();
  }
  for (int i = 0; i < 10; i++) {
    mutex.Lock();
    mutex.AssertHeld();
    acquired++;
    EpsilonRandomSleep();
    mutex.Unlock();
  }
  for (int i = 0; i < 10; i++) {
    if (mutex.TryLock()) {
      mutex.AssertHeld();
      acquired++;
      EpsilonRandomSleep();
      mutex.Unlock();
    }
  }
  for (int i = 0; i < 5; i++) {
    mutex.Lock();
    mutex.AssertHeld();
    acquired++;
    EpsilonRandomSleep();
    mutex.Unlock();
  }

  base::PlatformThread::Join(handle);

  EXPECT_GE(acquired, 20);
  EXPECT_GE(thread.acquired(), 20);
}

// Test that TryLock() works as expected ---------------------------------------

class TryLockTestThread : public base::PlatformThread::Delegate {
 public:
  explicit TryLockTestThread(Mutex* mutex) : mutex_(mutex), got_lock_(false) {}

  void ThreadMain() override MOJO_NO_THREAD_SAFETY_ANALYSIS {
    got_lock_ = mutex_->TryLock();
    if (got_lock_) {
      mutex_->AssertHeld();
      mutex_->Unlock();
    }
  }

  bool got_lock() const { return got_lock_; }

 private:
  Mutex* mutex_;
  bool got_lock_;

  MOJO_DISALLOW_COPY_AND_ASSIGN(TryLockTestThread);
};

TEST(MutexTest, TryLock) MOJO_NO_THREAD_SAFETY_ANALYSIS {
  Mutex mutex;

  ASSERT_TRUE(mutex.TryLock());
  // We now have the mutex....

  // This thread will not be able to get the mutex.
  {
    TryLockTestThread thread(&mutex);
    base::PlatformThreadHandle handle;

    ASSERT_TRUE(base::PlatformThread::Create(0, &thread, &handle));

    base::PlatformThread::Join(handle);

    ASSERT_FALSE(thread.got_lock());
  }

  mutex.Unlock();

  // This thread will....
  {
    TryLockTestThread thread(&mutex);
    base::PlatformThreadHandle handle;

    ASSERT_TRUE(base::PlatformThread::Create(0, &thread, &handle));

    base::PlatformThread::Join(handle);

    ASSERT_TRUE(thread.got_lock());
    // But it released it....
    ASSERT_TRUE(mutex.TryLock());
  }

  mutex.Unlock();
}

// Tests that mutexes actually exclude -----------------------------------------

class MutexLockTestThread : public base::PlatformThread::Delegate {
 public:
  MutexLockTestThread(Mutex* mutex, int* value)
      : mutex_(mutex), value_(value) {}

  // Static helper which can also be called from the main thread.
  static void DoStuff(Mutex* mutex, int* value) {
    for (int i = 0; i < 40; i++) {
      mutex->Lock();
      int v = *value;
      EpsilonRandomSleep();
      *value = v + 1;
      mutex->Unlock();
    }
  }

  void ThreadMain() override { DoStuff(mutex_, value_); }

 private:
  Mutex* mutex_;
  int* value_;

  MOJO_DISALLOW_COPY_AND_ASSIGN(MutexLockTestThread);
};

TEST(MutexTest, MutexTwoThreads) {
  Mutex mutex;
  int value = 0;

  MutexLockTestThread thread(&mutex, &value);
  base::PlatformThreadHandle handle;

  ASSERT_TRUE(base::PlatformThread::Create(0, &thread, &handle));

  MutexLockTestThread::DoStuff(&mutex, &value);

  base::PlatformThread::Join(handle);

  EXPECT_EQ(2 * 40, value);
}

TEST(MutexTest, MutexFourThreads) {
  Mutex mutex;
  int value = 0;

  MutexLockTestThread thread1(&mutex, &value);
  MutexLockTestThread thread2(&mutex, &value);
  MutexLockTestThread thread3(&mutex, &value);
  base::PlatformThreadHandle handle1;
  base::PlatformThreadHandle handle2;
  base::PlatformThreadHandle handle3;

  ASSERT_TRUE(base::PlatformThread::Create(0, &thread1, &handle1));
  ASSERT_TRUE(base::PlatformThread::Create(0, &thread2, &handle2));
  ASSERT_TRUE(base::PlatformThread::Create(0, &thread3, &handle3));

  MutexLockTestThread::DoStuff(&mutex, &value);

  base::PlatformThread::Join(handle1);
  base::PlatformThread::Join(handle2);
  base::PlatformThread::Join(handle3);

  EXPECT_EQ(4 * 40, value);
}

// MutexLocker -----------------------------------------------------------------

TEST(MutexTest, MutexLocker) {
  Mutex mutex;

  {
    MutexLocker locker(&mutex);
    mutex.AssertHeld();
  }

  // The destruction of |locker| should unlock |mutex|.
  ASSERT_TRUE(mutex.TryLock());
  mutex.AssertHeld();
  mutex.Unlock();
}

}  // namespace
}  // namespace system
}  // namespace mojo