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
|
// Copyright 2020 The Pigweed Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
#include <chrono>
#include "gtest/gtest.h"
#include "pw_chrono/system_clock.h"
#include "pw_sync/timed_mutex.h"
#include "pw_sync_private/borrow_lockable_tests.h"
using pw::chrono::SystemClock;
using namespace std::chrono_literals;
namespace pw::sync {
namespace {
extern "C" {
// Functions defined in mutex_facade_test_c.c which call the API from C.
void pw_sync_TimedMutex_CallLock(pw_sync_TimedMutex* mutex);
bool pw_sync_TimedMutex_CallTryLock(pw_sync_TimedMutex* mutex);
bool pw_sync_TimedMutex_CallTryLockFor(pw_sync_TimedMutex* mutex,
pw_chrono_SystemClock_Duration timeout);
bool pw_sync_TimedMutex_CallTryLockUntil(
pw_sync_TimedMutex* mutex, pw_chrono_SystemClock_TimePoint deadline);
void pw_sync_TimedMutex_CallUnlock(pw_sync_TimedMutex* mutex);
} // extern "C"
// We can't control the SystemClock's period configuration, so just in case
// duration cannot be accurately expressed in integer ticks, round the
// duration up.
constexpr SystemClock::duration kRoundedArbitraryDuration =
SystemClock::for_at_least(42ms);
constexpr pw_chrono_SystemClock_Duration kRoundedArbitraryDurationInC =
PW_SYSTEM_CLOCK_MS(42);
// TODO: b/235284163 - Add real concurrency tests once we have pw::thread.
TEST(TimedMutex, LockUnlock) {
TimedMutex mutex;
mutex.lock();
mutex.unlock();
// TODO: b/235284163 - Ensure it fails to lock when already held by someone
// else.
// EXPECT_FALSE(mutex.try_lock());
}
TimedMutex static_mutex;
TEST(TimedMutex, LockUnlockStatic) {
static_mutex.lock();
static_mutex.unlock();
// TODO: b/235284163 - Ensure it fails to lock when already held by someone
// else.
// EXPECT_FALSE(static_mutex.try_lock());
}
TEST(TimedMutex, TryLockUnlock) {
TimedMutex mutex;
const bool locked = mutex.try_lock();
EXPECT_TRUE(locked);
if (locked) {
// EXPECT_FALSE(mutex.try_lock());
mutex.unlock();
}
// TODO: b/235284163 - Ensure it fails to lock when already held by someone
// else.
}
TEST(TimedMutex, TryLockUnlockFor) {
TimedMutex mutex;
SystemClock::time_point before = SystemClock::now();
const bool locked = mutex.try_lock_for(kRoundedArbitraryDuration);
EXPECT_TRUE(locked);
if (locked) {
SystemClock::duration time_elapsed = SystemClock::now() - before;
EXPECT_LT(time_elapsed, kRoundedArbitraryDuration);
mutex.unlock();
}
// TODO: b/235284163 - Ensure it blocks and fails to lock when already held by
// someone else.
// TODO: b/235284163 - Ensure it does not block and fails to lock when already
// held by someone else and a zero length duration is used.
// TODO: b/235284163 - Ensure it does not block and fails to lock when already
// held by someone else and a negative duration is used.
}
TEST(TimedMutex, TryLockUnlockUntil) {
TimedMutex mutex;
const SystemClock::time_point deadline =
SystemClock::now() + kRoundedArbitraryDuration;
const bool locked = mutex.try_lock_until(deadline);
EXPECT_TRUE(locked);
if (locked) {
EXPECT_LT(SystemClock::now(), deadline);
mutex.unlock();
}
// TODO: b/235284163 - Ensure it blocks and fails to lock when already held by
// someone else.
// TODO: b/235284163 - Ensure it does not block and fails to lock when already
// held by someone else and now is used.
// TODO: b/235284163 - Ensure it does not block and fails to lock when already
// held by someone else and a timestamp in the past is used.
}
PW_SYNC_ADD_BORROWABLE_TIMED_LOCK_NAMED_TESTS(BorrowableTimedMutex,
TimedMutex,
chrono::SystemClock);
TEST(VirtualTimedMutex, LockUnlock) {
VirtualTimedMutex mutex;
mutex.lock();
// TODO: b/235284163 - Ensure it fails to lock when already held by someone
// else.
// EXPECT_FALSE(mutex.try_lock());
mutex.unlock();
}
VirtualTimedMutex static_virtual_mutex;
TEST(VirtualTimedMutex, LockUnlockStatic) {
static_virtual_mutex.lock();
// TODO: b/235284163 - Ensure it fails to lock when already held by someone
// else.
// EXPECT_FALSE(static_virtual_mutex.try_lock());
static_virtual_mutex.unlock();
}
TEST(VirtualMutex, LockUnlockExternal) {
VirtualTimedMutex virtual_timed_mutex;
auto& mutex = virtual_timed_mutex.timed_mutex();
mutex.lock();
// TODO: b/235284163 - Ensure it fails to lock when already held.
// EXPECT_FALSE(mutex.try_lock());
mutex.unlock();
}
PW_SYNC_ADD_BORROWABLE_TIMED_LOCK_NAMED_TESTS(BorrowableVirtualTimedMutex,
VirtualTimedMutex,
chrono::SystemClock);
TEST(TimedMutex, LockUnlockInC) {
TimedMutex mutex;
pw_sync_TimedMutex_CallLock(&mutex);
pw_sync_TimedMutex_CallUnlock(&mutex);
}
TEST(TimedMutex, TryLockUnlockInC) {
TimedMutex mutex;
ASSERT_TRUE(pw_sync_TimedMutex_CallTryLock(&mutex));
// TODO: b/235284163 - Ensure it fails to lock when already held by someone
// else.
// EXPECT_FALSE(pw_sync_TimedMutex_CallTryLock(&mutex));
pw_sync_TimedMutex_CallUnlock(&mutex);
}
TEST(TimedMutex, TryLockUnlockForInC) {
TimedMutex mutex;
pw_chrono_SystemClock_TimePoint before = pw_chrono_SystemClock_Now();
ASSERT_TRUE(
pw_sync_TimedMutex_CallTryLockFor(&mutex, kRoundedArbitraryDurationInC));
pw_chrono_SystemClock_Duration time_elapsed =
pw_chrono_SystemClock_TimeElapsed(before, pw_chrono_SystemClock_Now());
EXPECT_LT(time_elapsed.ticks, kRoundedArbitraryDurationInC.ticks);
pw_sync_TimedMutex_CallUnlock(&mutex);
// TODO: b/235284163 - Ensure it blocks and fails to lock when already held by
// someone else.
// TODO: b/235284163 - Ensure it does not block and fails to lock when already
// held by someone else and a zero length duration is used.
// TODO: b/235284163 - Ensure it does not block and fails to lock when already
// held by someone else and a negative duration is used.
}
TEST(TimedMutex, TryLockUnlockUntilInC) {
TimedMutex mutex;
pw_chrono_SystemClock_TimePoint deadline;
deadline.duration_since_epoch.ticks =
pw_chrono_SystemClock_Now().duration_since_epoch.ticks +
kRoundedArbitraryDurationInC.ticks;
ASSERT_TRUE(pw_sync_TimedMutex_CallTryLockUntil(&mutex, deadline));
EXPECT_LT(pw_chrono_SystemClock_Now().duration_since_epoch.ticks,
deadline.duration_since_epoch.ticks);
pw_sync_TimedMutex_CallUnlock(&mutex);
// TODO: b/235284163 - Ensure it blocks and fails to lock when already held by
// someone else.
// TODO: b/235284163 - Ensure it does not block and fails to lock when already
// held by someone else and now is used.
// TODO: b/235284163 - Ensure it does not block and fails to lock when already
// held by someone else and a timestamp in the past is used.
}
} // namespace
} // namespace pw::sync
|
