aboutsummaryrefslogtreecommitdiffstats
path: root/searchlib/src/vespa/searchlib/queryeval/global_filter.cpp
blob: d8a2c1c1d16a32b755b57c4c6e87bb575093d0d2 (plain) (blame)
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
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#include "global_filter.h"
#include "blueprint.h"
#include "profiled_iterator.h"
#include <vespa/vespalib/util/require.h>
#include <vespa/vespalib/util/thread_bundle.h>
#include <vespa/vespalib/util/execution_profiler.h>
#include <vespa/searchlib/common/bitvector.h>
#include <vespa/searchlib/engine/trace.h>
#include <vespa/vespalib/data/slime/slime.h>
#include <cassert>

using search::engine::Trace;
using vespalib::ExecutionProfiler;
using vespalib::Runnable;
using vespalib::ThreadBundle;
using vespalib::Trinary;

namespace search::queryeval {

namespace {

using namespace vespalib::literals;

struct Inactive : GlobalFilter {
    bool is_active() const override { return false; }
    uint32_t size() const override { abort(); }
    uint32_t count() const override { abort(); }
    bool check(uint32_t) const override { abort(); }
};

struct EmptyFilter : GlobalFilter {
    uint32_t docid_limit;
    EmptyFilter(uint32_t docid_limit_in) noexcept : docid_limit(docid_limit_in) {}
    ~EmptyFilter() override;
    bool is_active() const override { return true; }
    uint32_t size() const override { return docid_limit; }
    uint32_t count() const override { return 0; }
    bool check(uint32_t) const override { return false; }
};

EmptyFilter::~EmptyFilter() = default;

struct BitVectorFilter : public GlobalFilter {
    std::unique_ptr<BitVector> vector;
    BitVectorFilter(std::unique_ptr<BitVector> vector_in) noexcept
      : vector(std::move(vector_in)) {}
    bool is_active() const override { return true; }
    uint32_t size() const override { return vector->size(); }
    uint32_t count() const override { return vector->countTrueBits(); }
    bool check(uint32_t docid) const override { return vector->testBit(docid); }
};

struct MultiBitVectorFilter : public GlobalFilter {
    std::vector<std::unique_ptr<BitVector>> vectors;
    std::vector<uint32_t> splits;
    uint32_t total_size;
    uint32_t total_count;
    MultiBitVectorFilter(std::vector<std::unique_ptr<BitVector>> vectors_in,
                         std::vector<uint32_t> splits_in,
                         uint32_t total_size_in,
                         uint32_t total_count_in) noexcept
      : vectors(std::move(vectors_in)),
        splits(std::move(splits_in)),
        total_size(total_size_in),
        total_count(total_count_in) {}
    bool is_active() const override { return true; }
    uint32_t size() const override { return total_size; }
    uint32_t count() const override { return total_count; }
    bool check(uint32_t docid) const override {
        size_t i = 0;
        while ((i < splits.size()) && (docid >= splits[i])) {
            ++i;
        }
        return vectors[i]->testBit(docid);
    }
};

struct PartResult {
    Trinary matches_any;
    std::unique_ptr<BitVector> bits;
    PartResult()
      : matches_any(Trinary::False), bits() {}
    PartResult(Trinary matches_any_in)
      : matches_any(matches_any_in), bits() {}
    PartResult(std::unique_ptr<BitVector> &&bits_in)
      : matches_any(Trinary::Undefined), bits(std::move(bits_in)) {}
};

struct MakePart : Runnable {
    Blueprint &blueprint;
    uint32_t begin;
    uint32_t end;
    PartResult result;
    std::unique_ptr<Trace> trace;
    std::unique_ptr<ExecutionProfiler> profiler;
    MakePart(MakePart &&) = default;
    MakePart(Blueprint &blueprint_in, uint32_t begin_in, uint32_t end_in, Trace *parent_trace)
      : blueprint(blueprint_in), begin(begin_in), end(end_in), result(), trace(), profiler()
    {
        if (parent_trace && parent_trace->getLevel() > 0) {
            trace = parent_trace->make_trace_up();
            if (int32_t profile_depth = trace->match_profile_depth(); profile_depth != 0) {
                profiler = std::make_unique<ExecutionProfiler>(profile_depth);
            }
        }
    }
    bool is_first_thread() const { return (begin == 1); }
    bool should_trace(int level) const { return trace && trace->shouldTrace(level); }
    void run() override {
        bool strict = true;
        auto constraint = Blueprint::FilterConstraint::UPPER_BOUND;
        auto filter = blueprint.createFilterSearch(strict, constraint);
        if (is_first_thread() && should_trace(7)) {
            vespalib::slime::ObjectInserter inserter(trace->createCursor("iterator"), "optimized");
            filter->asSlime(inserter);
        }
        auto matches_any = filter->matches_any();
        if (matches_any == Trinary::Undefined) {
            if (profiler) {
                filter = ProfiledIterator::profile(*profiler, std::move(filter));
            }
            filter->initRange(begin, end);
            auto bits = filter->get_hits(begin);
            // count bits in parallel and cache the results for later
            bits->countTrueBits();
            result = PartResult(std::move(bits));
        } else {
            result = PartResult(matches_any);
        }
        if (profiler) {
            profiler->report(trace->createCursor("global_filter_profiling"));
        }
    }
    ~MakePart();
};
MakePart::~MakePart() = default;

void insert_traces(Trace *trace, const std::vector<MakePart> &parts) {
    if (trace) {
        auto inserter = trace->make_inserter("global_filter_execution"_ssv);
        for (const auto &part: parts) {
            if (part.trace) {
                inserter.handle_thread(*part.trace);
            }
        }
    }
}

}

GlobalFilter::GlobalFilter() noexcept = default;
GlobalFilter::~GlobalFilter() = default;

std::shared_ptr<GlobalFilter>
GlobalFilter::create() {
    return std::make_shared<Inactive>();
}

std::shared_ptr<GlobalFilter>
GlobalFilter::create(std::vector<uint32_t> docids, uint32_t size)
{
    uint32_t prev = 0;
    auto bits = BitVector::create(1, size);
    for (uint32_t docid: docids) {
        REQUIRE(docid > prev);
        REQUIRE(docid < size);
        bits->setBit(docid);
        prev = docid;
    }
    bits->invalidateCachedCount();
    return create(std::move(bits));
}

std::shared_ptr<GlobalFilter>
GlobalFilter::create(std::unique_ptr<BitVector> vector)
{
    return std::make_shared<BitVectorFilter>(std::move(vector));
}

std::shared_ptr<GlobalFilter>
GlobalFilter::create(std::vector<std::unique_ptr<BitVector>> vectors)
{
    uint32_t total_size = 1;
    uint32_t total_count = 0;
    std::vector<uint32_t> splits;
    splits.reserve(vectors.size());
    for (size_t i = 0; i < vectors.size(); ++i) {
        bool last = ((i + 1) == vectors.size());
        total_count += vectors[i]->countTrueBits();
        if (last) {
            total_size = vectors[i]->size();
        } else {
            REQUIRE_EQ(vectors[i]->size(), vectors[i + 1]->getStartIndex());
            splits.push_back(vectors[i]->size());
        }
    }
    return std::make_shared<MultiBitVectorFilter>(std::move(vectors), std::move(splits),
                                                  total_size, total_count);
}

std::shared_ptr<GlobalFilter>
GlobalFilter::create(Blueprint &blueprint, uint32_t docid_limit, ThreadBundle &thread_bundle, Trace *trace)
{
    uint32_t num_threads = thread_bundle.size();
    std::vector<MakePart> parts;
    parts.reserve(num_threads);
    uint32_t docid = 1;
    uint32_t per_thread = (docid_limit - docid) / num_threads;
    uint32_t rest_docs = (docid_limit - docid) % num_threads;
    while (docid < docid_limit) {
        uint32_t part_size = per_thread + (parts.size() < rest_docs);
        parts.emplace_back(blueprint, docid, docid + part_size, trace);
        docid += part_size;
    }
    assert(parts.size() <= num_threads);
    assert((docid == docid_limit) || parts.empty());
    thread_bundle.run(parts);
    insert_traces(trace, parts);
    std::vector<std::unique_ptr<BitVector>> vectors;
    vectors.reserve(parts.size());
    for (MakePart &part: parts) {
        switch (part.result.matches_any) {
        case Trinary::False: return std::make_unique<EmptyFilter>(docid_limit);
        case Trinary::True: return create(); // filter not needed after all
        case Trinary::Undefined:
            vectors.push_back(std::move(part.result.bits));
        }
    }
    if (vectors.size() == 1) {
        return create(std::move(vectors[0]));
    }
    return create(std::move(vectors));
}

}