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
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#include <vespa/vespalib/testkit/test_kit.h>
#include <vespa/vespalib/testkit/time_bomb.h>
#include <vespa/searchcore/proton/matching/docid_range_scheduler.h>
using namespace proton::matching;
using vespalib::TimeBomb;
void verify_range(DocidRange a, DocidRange b) {
EXPECT_EQUAL(a.begin, b.begin);
EXPECT_EQUAL(a.end, b.end);
}
//-----------------------------------------------------------------------------
TEST("require that default docid range constructor creates and empty range") {
EXPECT_TRUE(DocidRange().empty());
EXPECT_EQUAL(DocidRange().size(), 0u);
}
TEST("require that docid range ensures end is not less than begin") {
EXPECT_EQUAL(DocidRange(10, 20).size(), 10u);
EXPECT_TRUE(!DocidRange(10, 20).empty());
EXPECT_EQUAL(DocidRange(10, 20).begin, 10u);
EXPECT_EQUAL(DocidRange(10, 20).end, 20u);
EXPECT_EQUAL(DocidRange(20, 10).size(), 0u);
EXPECT_TRUE(DocidRange(20, 10).empty());
EXPECT_EQUAL(DocidRange(20, 10).begin, 20u);
EXPECT_EQUAL(DocidRange(20, 10).end, 20u);
}
//-----------------------------------------------------------------------------
TEST("require that default constructed IdleObserver is always zero") {
IdleObserver observer;
EXPECT_TRUE(observer.is_always_zero());
EXPECT_EQUAL(0u, observer.get());
}
TEST("require that IdleObserver can observe an atomic size_t value") {
std::atomic<size_t> idle(0);
IdleObserver observer(idle);
EXPECT_TRUE(!observer.is_always_zero());
EXPECT_EQUAL(0u, observer.get());
idle = 10;
EXPECT_EQUAL(10u, observer.get());
}
//-----------------------------------------------------------------------------
TEST("require that the docid range splitter can split a docid range") {
DocidRangeSplitter splitter(DocidRange(1, 16), 4);
TEST_DO(verify_range(splitter.get(0), DocidRange(1, 5)));
TEST_DO(verify_range(splitter.get(1), DocidRange(5, 9)));
TEST_DO(verify_range(splitter.get(2), DocidRange(9, 13)));
TEST_DO(verify_range(splitter.get(3), DocidRange(13, 16)));
}
TEST("require that the docid range splitter can split an empty range") {
DocidRangeSplitter splitter(DocidRange(5, 5), 2);
TEST_DO(verify_range(splitter.get(0), DocidRange(5, 5)));
TEST_DO(verify_range(splitter.get(1), DocidRange(5, 5)));
}
TEST("require that the docid range splitter can split a range into more parts than values") {
DocidRangeSplitter splitter(DocidRange(1, 4), 4);
TEST_DO(verify_range(splitter.get(0), DocidRange(1, 2)));
TEST_DO(verify_range(splitter.get(1), DocidRange(2, 3)));
TEST_DO(verify_range(splitter.get(2), DocidRange(3, 4)));
TEST_DO(verify_range(splitter.get(3), DocidRange(4, 4)));
}
TEST("require that the docid range splitter gives empty ranges if accessed with too high index") {
DocidRangeSplitter splitter(DocidRange(1, 4), 3);
TEST_DO(verify_range(splitter.get(0), DocidRange(1, 2)));
TEST_DO(verify_range(splitter.get(1), DocidRange(2, 3)));
TEST_DO(verify_range(splitter.get(2), DocidRange(3, 4)));
TEST_DO(verify_range(splitter.get(3), DocidRange(4, 4)));
TEST_DO(verify_range(splitter.get(100), DocidRange(4, 4)));
}
//-----------------------------------------------------------------------------
TEST("require that the partition scheduler acts as expected") {
PartitionDocidRangeScheduler scheduler(4, 16);
EXPECT_EQUAL(scheduler.total_size(0), 4u);
EXPECT_EQUAL(scheduler.total_size(1), 4u);
EXPECT_EQUAL(scheduler.total_size(2), 4u);
EXPECT_EQUAL(scheduler.total_size(3), 3u);
EXPECT_EQUAL(scheduler.unassigned_size(), 0u);
TEST_DO(verify_range(scheduler.first_range(0), DocidRange(1, 5)));
TEST_DO(verify_range(scheduler.first_range(1), DocidRange(5, 9)));
TEST_DO(verify_range(scheduler.first_range(2), DocidRange(9, 13)));
TEST_DO(verify_range(scheduler.first_range(3), DocidRange(13, 16)));
TEST_DO(verify_range(scheduler.next_range(0), DocidRange()));
TEST_DO(verify_range(scheduler.next_range(1), DocidRange()));
TEST_DO(verify_range(scheduler.next_range(2), DocidRange()));
TEST_DO(verify_range(scheduler.next_range(3), DocidRange()));
}
TEST("require that the partition scheduler protects against documents underflow") {
PartitionDocidRangeScheduler scheduler(2, 0);
EXPECT_EQUAL(scheduler.total_size(0), 0u);
EXPECT_EQUAL(scheduler.total_size(1), 0u);
EXPECT_EQUAL(scheduler.unassigned_size(), 0u);
TEST_DO(verify_range(scheduler.first_range(0), DocidRange(1,1)));
TEST_DO(verify_range(scheduler.first_range(1), DocidRange(1,1)));
TEST_DO(verify_range(scheduler.next_range(0), DocidRange()));
TEST_DO(verify_range(scheduler.next_range(1), DocidRange()));
}
//-----------------------------------------------------------------------------
TEST("require that the task scheduler acts as expected") {
TaskDocidRangeScheduler scheduler(2, 5, 20);
EXPECT_EQUAL(scheduler.unassigned_size(), 19u);
EXPECT_EQUAL(scheduler.total_size(0), 0u);
EXPECT_EQUAL(scheduler.total_size(1), 0u);
TEST_DO(verify_range(scheduler.first_range(1), DocidRange(1, 5)));
TEST_DO(verify_range(scheduler.first_range(0), DocidRange(5, 9)));
TEST_DO(verify_range(scheduler.next_range(0), DocidRange(9, 13)));
EXPECT_EQUAL(scheduler.unassigned_size(), 7u);
TEST_DO(verify_range(scheduler.next_range(1), DocidRange(13, 17)));
TEST_DO(verify_range(scheduler.next_range(0), DocidRange(17, 20)));
TEST_DO(verify_range(scheduler.next_range(0), DocidRange(20, 20)));
TEST_DO(verify_range(scheduler.next_range(1), DocidRange(20, 20)));
EXPECT_EQUAL(scheduler.total_size(0), 11u);
EXPECT_EQUAL(scheduler.total_size(1), 8u);
EXPECT_EQUAL(scheduler.unassigned_size(), 0u);
}
TEST("require that the task scheduler protects against documents underflow") {
TaskDocidRangeScheduler scheduler(2, 4, 0);
EXPECT_EQUAL(scheduler.total_size(0), 0u);
EXPECT_EQUAL(scheduler.total_size(1), 0u);
EXPECT_EQUAL(scheduler.unassigned_size(), 0u);
TEST_DO(verify_range(scheduler.first_range(0), DocidRange(1,1)));
TEST_DO(verify_range(scheduler.first_range(1), DocidRange(1,1)));
TEST_DO(verify_range(scheduler.next_range(0), DocidRange(1,1)));
TEST_DO(verify_range(scheduler.next_range(1), DocidRange(1,1)));
}
//-----------------------------------------------------------------------------
TEST("require that the adaptive scheduler starts by dividing the docid space equally") {
AdaptiveDocidRangeScheduler scheduler(4, 1, 16);
EXPECT_EQUAL(scheduler.total_size(0), 4u);
EXPECT_EQUAL(scheduler.total_size(1), 4u);
EXPECT_EQUAL(scheduler.total_size(2), 4u);
EXPECT_EQUAL(scheduler.total_size(3), 3u);
EXPECT_EQUAL(scheduler.unassigned_size(), 0u);
TEST_DO(verify_range(scheduler.first_range(0), DocidRange(1, 5)));
TEST_DO(verify_range(scheduler.first_range(1), DocidRange(5, 9)));
TEST_DO(verify_range(scheduler.first_range(2), DocidRange(9, 13)));
TEST_DO(verify_range(scheduler.first_range(3), DocidRange(13, 16)));
}
TEST_MT_FF("require that the adaptive scheduler terminates when all workers request more work",
4, AdaptiveDocidRangeScheduler(num_threads, 1, 16), TimeBomb(60))
{
(void) f1.first_range(thread_id);
DocidRange range = f1.next_range(thread_id);
EXPECT_TRUE(range.empty());
}
void wait_idle(const DocidRangeScheduler &scheduler, size_t wanted) {
IdleObserver observer = scheduler.make_idle_observer();
while (observer.get() != wanted) {
std::this_thread::sleep_for(std::chrono::milliseconds(1));
}
}
TEST_MT_FF("require that the adaptive scheduler enables threads to share work",
3, AdaptiveDocidRangeScheduler(num_threads, 1, 28), TimeBomb(60))
{
DocidRange range = f1.first_range(thread_id);
if (thread_id == 0) {
TEST_DO(verify_range(range, DocidRange(1,10)));
} else if (thread_id == 1) {
TEST_DO(verify_range(range, DocidRange(10,19)));
} else {
TEST_DO(verify_range(range, DocidRange(19,28)));
}
EXPECT_EQUAL(f1.total_size(thread_id), 9u);
TEST_DO(verify_range(f1.share_range(thread_id, range), range));
TEST_BARRIER();
if (thread_id == 0) {
TEST_DO(verify_range(f1.next_range(thread_id), DocidRange(25,28)));
} else if (thread_id == 1) {
wait_idle(f1, 1);
TEST_DO(verify_range(f1.next_range(thread_id), DocidRange(22,25)));
} else {
wait_idle(f1, 2);
verify_range(f1.share_range(thread_id, range), DocidRange(19,22));
}
TEST_DO(verify_range(f1.next_range(thread_id), DocidRange()));
EXPECT_EQUAL(f1.total_size(0), 12u);
EXPECT_EQUAL(f1.total_size(1), 12u);
EXPECT_EQUAL(f1.total_size(2), 3u);
}
TEST_MT_FF("require that the adaptive scheduler protects against documents underflow",
2, AdaptiveDocidRangeScheduler(num_threads, 1, 0), TimeBomb(60))
{
TEST_DO(verify_range(f1.first_range(thread_id), DocidRange()));
EXPECT_EQUAL(f1.total_size(thread_id), 0u);
EXPECT_EQUAL(f1.unassigned_size(), 0u);
}
TEST_MT_FF("require that the adaptive scheduler respects the minimal task size",
2, AdaptiveDocidRangeScheduler(num_threads, 3, 21), TimeBomb(60))
{
EXPECT_EQUAL(f1.first_range(thread_id).size(), 10u);
if (thread_id == 0) {
TEST_DO(verify_range(f1.next_range(thread_id), DocidRange(18,21)));
TEST_DO(verify_range(f1.next_range(thread_id), DocidRange()));
} else {
wait_idle(f1, 1);
// a range with size 5 will not be split
TEST_DO(verify_range(f1.share_range(thread_id, DocidRange(16,21)), DocidRange(16,21)));
// a range with size 6 will be split
TEST_DO(verify_range(f1.share_range(thread_id, DocidRange(15,21)), DocidRange(15,18)));
TEST_DO(verify_range(f1.next_range(thread_id), DocidRange()));
}
}
TEST_MT_FF("require that the adaptive scheduler will never split a task with size 1",
2, AdaptiveDocidRangeScheduler(num_threads, 0, 21), TimeBomb(60))
{
EXPECT_EQUAL(f1.first_range(thread_id).size(), 10u);
if (thread_id == 0) {
TEST_DO(verify_range(f1.next_range(thread_id), DocidRange()));
} else {
IdleObserver observer = f1.make_idle_observer();
while (observer.get() == 0) {
std::this_thread::sleep_for(std::chrono::milliseconds(1));
}
DocidRange small_range = DocidRange(20,21);
verify_range(f1.share_range(thread_id, small_range), small_range);
TEST_DO(verify_range(f1.next_range(thread_id), DocidRange()));
}
}
TEST_MT_FF("require that the adaptive scheduler can leave idle workers alone due to minimal task size",
3, AdaptiveDocidRangeScheduler(num_threads, 3, 28), TimeBomb(60))
{
EXPECT_EQUAL(f1.first_range(thread_id).size(), 9u);
if (thread_id == 0) {
TEST_DO(verify_range(f1.next_range(thread_id), DocidRange()));
} else if (thread_id == 1) {
wait_idle(f1, 1);
TEST_DO(verify_range(f1.next_range(thread_id), DocidRange(24,28)));
TEST_DO(verify_range(f1.next_range(thread_id), DocidRange()));
} else {
wait_idle(f1, 2);
verify_range(f1.share_range(thread_id, DocidRange(20,28)), DocidRange(20,24));
TEST_DO(verify_range(f1.next_range(thread_id), DocidRange()));
}
EXPECT_EQUAL(f1.total_size(0), 9u);
EXPECT_EQUAL(f1.total_size(1), 13u);
EXPECT_EQUAL(f1.total_size(2), 5u);
}
TEST_MT_FF("require that the adaptive scheduler handles no documents",
4, AdaptiveDocidRangeScheduler(num_threads, 1, 1), TimeBomb(60))
{
for (DocidRange docid_range = f1.first_range(thread_id);
!docid_range.empty();
docid_range = f1.next_range(thread_id))
{
TEST_ERROR("no threads should get any work");
}
}
TEST_MT_FF("require that the adaptive scheduler handles fewer documents than threads",
4, AdaptiveDocidRangeScheduler(num_threads, 1, 3), TimeBomb(60))
{
for (DocidRange docid_range = f1.first_range(thread_id);
!docid_range.empty();
docid_range = f1.next_range(thread_id))
{
EXPECT_TRUE(docid_range.size() == 1);
EXPECT_TRUE(thread_id < 2);
}
}
//-----------------------------------------------------------------------------
TEST_MAIN() { TEST_RUN_ALL(); }
|
