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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
|
/*
* Copyright (C) 2022 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "ThreadSafeObjectHeap.h"
#include <atomic>
#include <wtf/threads/BinarySemaphore.h>
namespace TestWebKitAPI {
namespace {
enum class TestedObjectIdentifierType { };
using TestedObjectIdentifier = AtomicObjectIdentifier<TestedObjectIdentifierType>;
using TestedObjectReadReference = IPC::ObjectIdentifierReadReference<TestedObjectIdentifier>;
using TestedObjectWriteReference = IPC::ObjectIdentifierWriteReference<TestedObjectIdentifier>;
using TestedObjectReference = IPC::ObjectIdentifierReference<TestedObjectIdentifier>;
using TestedObjectReferenceTracker = IPC::ObjectIdentifierReferenceTracker<TestedObjectIdentifier>;
// TestObject instances are the instances that the receiver stores in its object heap.
class TestedObject : public ThreadSafeRefCounted<TestedObject> {
public:
static Ref<TestedObject> create(int value)
{
return adoptRef(*new TestedObject(value));
}
~TestedObject()
{
s_instances--;
}
int value() const { return m_value; }
static size_t instances() { return s_instances; }
private:
TestedObject(int value)
: m_value(value)
{
s_instances++;
}
const int m_value;
static std::atomic<size_t> s_instances;
};
std::atomic<size_t> TestedObject::s_instances;
class ThreadSafeObjectHeapTest : public testing::Test {
protected:
void SetUp() override
{
WTF::initializeMainThread();
}
void TearDown() override
{
ASSERT_EQ(TestedObject::instances(), 0u);
}
// These are for the reference tracking that happens in the sender.
TestedObjectReferenceTracker m_referenceTracker { TestedObjectIdentifier::generate() };
auto newAddReference() { return m_referenceTracker.add(); }
auto newWriteReference() { return m_referenceTracker.write(); }
auto newReadReference() { return m_referenceTracker.read(); }
};
}
TEST_F(ThreadSafeObjectHeapTest, AddAndGetWorks)
{
{
IPC::ThreadSafeObjectHeap<TestedObjectIdentifier, Ref<TestedObject>> heap;
EXPECT_TRUE(heap.add(newAddReference(), TestedObject::create(344)));
auto read1 = newReadReference();
EXPECT_EQ(344, heap.get(read1, 0_s)->value());
EXPECT_EQ(1u, TestedObject::instances());
EXPECT_EQ(1u, heap.sizeForTesting());
}
EXPECT_EQ(0u, TestedObject::instances());
}
TEST_F(ThreadSafeObjectHeapTest, CompleteReadAfterRemoveWithPendingRead)
{
IPC::ThreadSafeObjectHeap<TestedObjectIdentifier, Ref<TestedObject>> heap;
EXPECT_TRUE(heap.add(newAddReference(), TestedObject::create(345)));
auto read1 = newReadReference();
auto remove = newWriteReference();
heap.remove(WTFMove(remove)); // Non-blocking remove.
EXPECT_EQ(1u, TestedObject::instances());
EXPECT_EQ(345, heap.read(WTFMove(read1), 0_s)->value());
EXPECT_EQ(0u, heap.sizeForTesting());
EXPECT_EQ(0u, TestedObject::instances());
}
TEST_F(ThreadSafeObjectHeapTest, ReadWriteWorks)
{
IPC::ThreadSafeObjectHeap<TestedObjectIdentifier, Ref<TestedObject>> heap;
EXPECT_TRUE(heap.add(newAddReference(), TestedObject::create(1)));
auto read1 = newReadReference();
auto write1 = newWriteReference();
EXPECT_EQ(1, heap.read(WTFMove(read1), 0_s)->value());
EXPECT_EQ(1, heap.take(WTFMove(write1), 0_s)->value());
EXPECT_EQ(0u, TestedObject::instances());
}
TEST_F(ThreadSafeObjectHeapTest, RemoveWorks)
{
IPC::ThreadSafeObjectHeap<TestedObjectIdentifier, Ref<TestedObject>> heap;
EXPECT_TRUE(heap.add(newAddReference(), TestedObject::create(1)));
EXPECT_EQ(1, heap.read(newReadReference(), 0_s)->value());
auto write1 = newWriteReference();
EXPECT_EQ(1u, TestedObject::instances());
EXPECT_TRUE(heap.remove(WTFMove(write1)));
EXPECT_EQ(0u, heap.sizeForTesting());
EXPECT_EQ(0u, TestedObject::instances());
}
TEST_F(ThreadSafeObjectHeapTest, WriteBeforeRetireEarlierReadTimesOut)
{
IPC::ThreadSafeObjectHeap<TestedObjectIdentifier, Ref<TestedObject>> heap;
EXPECT_TRUE(heap.add(newAddReference(), TestedObject::create(1)));
auto read1 = newReadReference();
auto write1 = newWriteReference();
// Test that take times out.
EXPECT_EQ(nullptr, heap.take(WTFMove(write1), 0_s));
// Ensure that write works after read.
EXPECT_EQ(1, heap.read(WTFMove(read1), 0_s)->value());
EXPECT_EQ(1, heap.take(WTFMove(write1), 0_s)->value());
EXPECT_EQ(0u, TestedObject::instances());
EXPECT_EQ(0u, heap.sizeForTesting());
}
TEST_F(ThreadSafeObjectHeapTest, ReadBeforeRetireEarlierWriteTimesOut)
{
IPC::ThreadSafeObjectHeap<TestedObjectIdentifier, Ref<TestedObject>> heap;
heap.add(newAddReference(), TestedObject::create(1));
auto write1 = newWriteReference();
auto read1 = newReadReference();
auto newReference = write1.retiredReference();
EXPECT_EQ(nullptr, heap.read(WTFMove(read1), 0_s));
EXPECT_EQ(1, heap.take(WTFMove(write1), 0_s)->value());
EXPECT_TRUE(heap.add(newReference, TestedObject::create(2)));
EXPECT_EQ(2, heap.get(read1, 0_s)->value());
}
TEST_F(ThreadSafeObjectHeapTest, RemoveBeforeAdd)
{
IPC::ThreadSafeObjectHeap<TestedObjectIdentifier, Ref<TestedObject>> heap;
auto add1 = newAddReference();
auto write1 = newWriteReference();
EXPECT_TRUE(heap.remove(WTFMove(write1)));
EXPECT_EQ(1u, heap.sizeForTesting());
EXPECT_TRUE(heap.add(add1, TestedObject::create(1)));
EXPECT_EQ(0u, TestedObject::instances());
EXPECT_EQ(0u, heap.sizeForTesting());
}
TEST_F(ThreadSafeObjectHeapTest, RemoveBeforeAddAndReads)
{
IPC::ThreadSafeObjectHeap<TestedObjectIdentifier, Ref<TestedObject>> heap;
auto add1 = newAddReference();
auto read1 = newReadReference();
auto read2 = newReadReference();
auto read3 = newReadReference();
auto write1 = newWriteReference();
EXPECT_TRUE(heap.remove(WTFMove(write1)));
EXPECT_EQ(1u, heap.sizeForTesting());
EXPECT_TRUE(heap.add(add1, TestedObject::create(1)));
EXPECT_EQ(1u, TestedObject::instances());
EXPECT_EQ(1, heap.read(WTFMove(read1), 0_s)->value());
EXPECT_EQ(1u, TestedObject::instances());
EXPECT_EQ(1, heap.read(WTFMove(read2), 0_s)->value());
EXPECT_EQ(1u, TestedObject::instances());
EXPECT_EQ(1, heap.read(WTFMove(read3), 0_s)->value());
EXPECT_EQ(0u, TestedObject::instances());
EXPECT_EQ(0u, heap.sizeForTesting());
}
TEST_F(ThreadSafeObjectHeapTest, RemoveBeforeReads)
{
IPC::ThreadSafeObjectHeap<TestedObjectIdentifier, Ref<TestedObject>> heap;
auto add1 = newAddReference();
auto read1 = newReadReference();
auto read2 = newReadReference();
auto read3 = newReadReference();
auto write1 = newWriteReference();
EXPECT_TRUE(heap.add(add1, TestedObject::create(1)));
EXPECT_EQ(1u, heap.sizeForTesting());
EXPECT_TRUE(heap.remove(WTFMove(write1)));
EXPECT_EQ(1u, TestedObject::instances());
EXPECT_EQ(1, heap.read(WTFMove(read1), 0_s)->value());
EXPECT_EQ(1u, TestedObject::instances());
EXPECT_EQ(1, heap.read(WTFMove(read2), 0_s)->value());
EXPECT_EQ(1u, TestedObject::instances());
EXPECT_EQ(1, heap.read(WTFMove(read3), 0_s)->value());
EXPECT_EQ(0u, TestedObject::instances());
EXPECT_EQ(0u, heap.sizeForTesting());
}
TEST_F(ThreadSafeObjectHeapTest, RemoveBeforeWritesAndReads)
{
IPC::ThreadSafeObjectHeap<TestedObjectIdentifier, Ref<TestedObject>> heap;
auto add1 = newAddReference();
auto write1 = newWriteReference();
auto add2 = newAddReference();
auto read2 = newReadReference();
auto write2 = newWriteReference();
auto add3 = newAddReference();
auto read3 = newReadReference();
auto write3 = newWriteReference();
EXPECT_TRUE(heap.remove(WTFMove(write3)));
EXPECT_TRUE(heap.remove(WTFMove(write2)));
EXPECT_TRUE(heap.remove(WTFMove(write1)));
EXPECT_EQ(3u, heap.sizeForTesting());
EXPECT_EQ(0u, TestedObject::instances());
EXPECT_TRUE(heap.add(add1, TestedObject::create(1)));
EXPECT_TRUE(heap.add(add2, TestedObject::create(2)));
EXPECT_TRUE(heap.add(add3, TestedObject::create(3)));
EXPECT_EQ(2u, TestedObject::instances());
EXPECT_EQ(2u, heap.sizeForTesting());
EXPECT_EQ(2, heap.read(WTFMove(read2), 0_s)->value());
EXPECT_EQ(1u, TestedObject::instances());
EXPECT_EQ(3, heap.read(WTFMove(read3), 0_s)->value());
EXPECT_EQ(0u, TestedObject::instances());
}
TEST_F(ThreadSafeObjectHeapTest, InvalidRemoveTwice)
{
IPC::ThreadSafeObjectHeap<TestedObjectIdentifier, Ref<TestedObject>> heap;
TestedObjectWriteReference write1 { TestedObjectReference::generateForAdd(), 0 };
TestedObjectWriteReference write2 { write1.reference(), 0 };
TestedObjectWriteReference write3 { write1.reference(), 0 };
EXPECT_TRUE(heap.remove(WTFMove(write1)));
EXPECT_FALSE(heap.remove(WTFMove(write2)));
EXPECT_FALSE(heap.take(WTFMove(write3), 0_s));
}
TEST_F(ThreadSafeObjectHeapTest, InvalidRemoveTooFewReads)
{
IPC::ThreadSafeObjectHeap<TestedObjectIdentifier, Ref<TestedObject>> heap;
auto add1 = newAddReference();
auto read1 = newReadReference();
EXPECT_TRUE(heap.add(add1, TestedObject::create(1)));
EXPECT_EQ(1, heap.read(WTFMove(read1), 0_s)->value());
// Already read once, but trying to remove with 0 pending reads.
TestedObjectWriteReference write1 { add1, 0 };
TestedObjectWriteReference write2 { add1, 0 };
EXPECT_FALSE(heap.remove(WTFMove(write1)));
EXPECT_FALSE(heap.take(WTFMove(write2), 0_s));
}
TEST_F(ThreadSafeObjectHeapTest, InvalidAddTwice)
{
IPC::ThreadSafeObjectHeap<TestedObjectIdentifier, Ref<TestedObject>> heap;
auto add1 = newAddReference();
EXPECT_TRUE(heap.add(add1, TestedObject::create(1)));
EXPECT_FALSE(heap.add(add1, TestedObject::create(1)));
}
}
|
