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
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#include <vespa/searchlib/common/bitvector.h>
#include <vespa/searchlib/common/bitvectoriterator.h>
#include <vespa/searchlib/queryeval/orsearch.h>
#include <vespa/searchlib/queryeval/unpackinfo.h>
#include <vespa/searchlib/queryeval/multibitvectoriterator.h>
#include <vespa/searchlib/fef/termfieldmatchdata.h>
#include <vespa/vespalib/util/stash.h>
#include <vespa/vespalib/util/benchmark_timer.h>
#include <vespa/vespalib/gtest/gtest.h>
#include <vector>
#include <random>
using namespace search;
using namespace vespalib;
using search::queryeval::SearchIterator;
using search::queryeval::OrSearch;
using search::queryeval::UnpackInfo;
using TMD = search::fef::TermFieldMatchData;
double budget = 0.25;
size_t bench_docs = 1000;
constexpr uint32_t default_seed = 5489u;
std::mt19937 gen(default_seed);
BitVector::UP make_bitvector(size_t size, size_t num_bits) {
EXPECT_GT(size, num_bits);
auto bv = BitVector::create(size);
size_t bits_left = num_bits;
// bit 0 is never set since it is reserved
// all other bits have equal probability to be set
for (size_t i = 1; i < size; ++i) {
std::uniform_int_distribution<size_t> space(0,size-i-1);
if (space(gen) < bits_left) {
bv->setBit(i);
--bits_left;
}
}
bv->invalidateCachedCount();
EXPECT_EQ(bv->countTrueBits(), num_bits);
return bv;
}
// simple strict array-based iterator
// This class has 2 uses:
// 1: better performance for few hits compared to bitvector
// 2: not a bitvector, useful when testing multi-bitvector interactions
struct ArrayIterator : SearchIterator {
uint32_t my_offset = 0;
uint32_t my_limit;
std::vector<uint32_t> my_hits;
TMD &my_match_data;
ArrayIterator(const BitVector &bv, TMD &tmd)
: my_limit(bv.size()), my_match_data(tmd)
{
uint32_t next = bv.getStartIndex();
for (;;) {
next = bv.getNextTrueBit(next);
if (next >= my_limit) {
break;
}
my_hits.push_back(next++);
}
my_match_data.reset(0);
}
void initRange(uint32_t begin, uint32_t end) final {
SearchIterator::initRange(begin, end);
my_offset = 0;
}
void doSeek(uint32_t docid) final {
while (my_offset < my_hits.size() && my_hits[my_offset] < docid) {
++my_offset;
}
if (my_offset < my_hits.size()) {
setDocId(my_hits[my_offset]);
} else {
setAtEnd();
}
}
Trinary is_strict() const final { return Trinary::True; }
void doUnpack(uint32_t docId) final { my_match_data.resetOnlyDocId(docId); }
};
struct OrSetup {
uint32_t docid_limit;
bool unpack_all = true;
bool unpack_none = true;
std::vector<std::unique_ptr<TMD>> match_data;
std::vector<BitVector::UP> child_hits;
std::vector<bool> use_array;
OrSetup(uint32_t docid_limit_in) noexcept : docid_limit(docid_limit_in) {}
size_t per_child(double target, size_t child_cnt) {
size_t result = (docid_limit * target) / child_cnt;
return (result >= docid_limit) ? (docid_limit - 1) : result;
}
bool should_use_array(size_t hits) {
return (docid_limit / hits) >= 32;
}
OrSetup &add(size_t num_hits, bool use_array_in, bool need_unpack) {
match_data.push_back(std::make_unique<TMD>());
child_hits.push_back(make_bitvector(docid_limit, num_hits));
use_array.push_back(use_array_in);
if (need_unpack) {
match_data.back()->setNeedNormalFeatures(true);
match_data.back()->setNeedInterleavedFeatures(true);
unpack_none = false;
} else {
match_data.back()->tagAsNotNeeded();
unpack_all = false;
}
return *this;
}
SearchIterator::UP make_leaf(size_t i) {
if (use_array[i]) {
return std::make_unique<ArrayIterator>(*child_hits[i], *match_data[i]);
} else {
return BitVectorIterator::create(child_hits[i].get(), *match_data[i], true);
}
}
SearchIterator::UP make_or(bool optimize = false) {
assert(!child_hits.empty());
if (child_hits.size() == 1) {
// use child directly if there is only one
return make_leaf(0);
}
std::vector<SearchIterator::UP> children;
for (size_t i = 0; i < child_hits.size(); ++i) {
children.push_back(make_leaf(i));
}
UnpackInfo unpack;
if (unpack_all) {
unpack.forceAll();
} else if (!unpack_none) {
for (size_t i = 0; i < match_data.size(); ++i) {
if (!match_data[i]->isNotNeeded()) {
unpack.add(i);
}
}
}
auto result = OrSearch::create(std::move(children), true, unpack);
if (optimize) {
result = queryeval::MultiBitVectorIteratorBase::optimize(std::move(result));
}
return result;
}
OrSetup &prepare_bm(size_t child_cnt, size_t hits_per_child) {
for (size_t i = 0; i < child_cnt; ++i) {
add(hits_per_child, should_use_array(hits_per_child), false);
}
return *this;
}
std::pair<size_t,double> bm_search_ms(bool optimized = false) {
auto search_up = make_or(optimized);
SearchIterator &search = *search_up;
size_t hits = 0;
BenchmarkTimer timer(budget);
while (timer.has_budget()) {
timer.before();
hits = 0;
search.initRange(1, docid_limit);
uint32_t docid = search.seekFirst(1);
while (docid < docid_limit) {
++hits;
docid = search.seekNext(docid + 1);
// no unpack
}
timer.after();
}
return std::make_pair(hits, timer.min_time() * 1000.0);
}
~OrSetup();
};
OrSetup::~OrSetup() = default;
TEST(OrSpeed, array_iterator) {
TMD match_data;
auto bv = make_bitvector(100, 10);
auto arr = std::make_unique<ArrayIterator>(*bv, match_data);
EXPECT_EQ(arr->my_limit, 100);
EXPECT_EQ(arr->my_hits.size(), 10);
EXPECT_EQ(match_data.getDocId(), 0);
for (int i = 0; i < 3; ++i) {
arr->initRange(1, 100);
EXPECT_EQ(arr->getDocId(), 0);
uint32_t hits = 0;
uint32_t docid = arr->seekFirst(1);
while (docid < 100) {
++hits;
EXPECT_TRUE(bv->testBit(docid));
arr->unpack(docid);
EXPECT_EQ(match_data.getDocId(), docid);
docid = arr->seekNext(docid + 1);
}
EXPECT_EQ(hits, 10);
}
}
TEST(OrSpeed, bm_array_vs_bitvector) {
for (size_t one_of: {16, 32, 64}) {
double target = 1.0 / one_of;
size_t hits = target * bench_docs;
OrSetup setup(bench_docs);
setup.add(hits, false, false);
for (bool use_array: {false, true}) {
setup.use_array[0] = use_array;
auto result = setup.bm_search_ms();
fprintf(stderr, "LEAF(%s): (one of %4zu) hits: %8zu, time: %10.3f ms, time per hits: %10.3f ns\n", use_array
? " array"
: "bitvector", one_of, result.first, result.second, (result.second * 1000.0 * 1000.0) / result.first);
}
}
}
TEST(OrSpeed, bm_strict_or) {
for (double target: {0.001, 0.01, 0.1, 1.0, 10.0}) {
for (size_t child_cnt: {5, 10, 100, 1000}) {
OrSetup setup(bench_docs);
size_t part = setup.per_child(target, child_cnt);
if (part > 0) {
auto result = setup.prepare_bm(child_cnt, part).bm_search_ms();
fprintf(stderr, "OR bench(children: %4zu, hits_per_child: %8zu): total_hits: %8zu, time: %10.3f ms, time per hits: %10.3f ns\n",
child_cnt, part, result.first, result.second, (result.second * 1000.0 * 1000.0) / result.first);
}
}
}
}
int main(int argc, char **argv) {
if (argc > 1 && (argv[1] == std::string("bench"))) {
budget = 5.0;
bench_docs = 10'000'000;
fprintf(stderr, "running in benchmarking mode\n");
++argv;
--argc;
}
::testing::InitGoogleTest(&argc, argv);
return RUN_ALL_TESTS();
}
|
