aboutsummaryrefslogtreecommitdiffstats
path: root/searchlib/src/vespa/searchlib/grouping/sketch.h
blob: 6a2082b793dedef7fc1e830fea5466ca02f5a271 (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
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
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#pragma once

#include <vespa/vespalib/util/compressionconfig.h>
#include <vespa/vespalib/util/compressor.h>
#include <lz4.h>
#include <vespa/searchlib/common/identifiable.h>
#include <vespa/vespalib/data/databuffer.h>
#include <vespa/vespalib/objects/deserializer.h>
#include <vespa/vespalib/objects/identifiable.h>
#include <vespa/vespalib/objects/serializer.h>
#include <algorithm>
#include <unordered_set>
#include <ostream>

namespace search {

template <int BucketBits, typename HashT> struct NormalSketch;

/**
 * Sketch interface.
 */
template <int BucketBits, typename HashT>
struct Sketch {
    enum { bucketBits = BucketBits };
    using hash_type = HashT;
    using SketchType = Sketch<BucketBits, HashT>;
    using UP = std::unique_ptr<SketchType>;

    static const HashT BUCKET_COUNT = HashT(1) << BucketBits;
    static const HashT BUCKET_MASK = BUCKET_COUNT - 1;

    virtual ~Sketch() = default;

    virtual int aggregate(HashT hash) = 0;

    [[nodiscard]] virtual uint32_t getClassId() const = 0;
    virtual void serialize(vespalib::Serializer &os) const = 0;
    virtual void deserialize(vespalib::Deserializer &is) = 0;

    virtual bool operator==(const SketchType &other) const = 0;
    virtual void print(std::ostream &out) const = 0;
};
template <int BucketBits, typename HashT>
std::ostream &operator<<(std::ostream &o, const Sketch<BucketBits, HashT> &s) {
    o << "[";
    s.print(o);
    return o << " ]";
}


template <typename T>
uint8_t countPrefixZeros(T t) {
    uint8_t count = 0;
    const T FIRST_BIT = T(1) << ((sizeof(T) * 8) - 1);
    while (!((t << count) & FIRST_BIT)) {
        ++count;
    }
    return ++count;
}


/**
 * Sketch containing a set of hashes
 */
template <int BucketBits = 10, typename HashT = uint32_t>
struct SparseSketch : Sketch<BucketBits, HashT> {
    using typename Sketch<BucketBits, HashT>::SketchType;
    enum { classId = IDENTIFIABLE_CLASSID_NS(search, SparseSketch) };

    struct IdentityHash {
        size_t operator()(HashT hash) const noexcept { return hash; }
    };
    std::unordered_set<HashT, IdentityHash> hash_set;

    ~SparseSketch() override;
    [[nodiscard]] size_t getSize() const { return hash_set.size(); }

    int aggregate(HashT hash) override {
        return hash_set.insert(hash).second ? 1 : 0;
    }

    [[nodiscard]] uint32_t getClassId() const override { return classId; }
    void serialize(vespalib::Serializer &os) const override;
    void deserialize(vespalib::Deserializer &is) override;

    bool operator==(const SketchType &other) const override {
        const auto *other_sparse = dynamic_cast<const SparseSketch<BucketBits, HashT> *>(&other);
        if (!other_sparse) {
            return false;
        }
        if (hash_set.size() != other_sparse->hash_set.size()) {
            return false;
        }
        for (auto hash : hash_set) {
            if (other_sparse->hash_set.count(hash) == 0) {
                return false;
            }
        }
        return true;
    }
    bool operator==(const SparseSketch<BucketBits, HashT>& other) const {
        return operator==(static_cast<const SketchType&>(other));
    }

    void print(std::ostream &out) const override {
        out << " (" << hash_set.size() << " elements)";
        for (auto hash : hash_set) {
            out << " 0x" << std::hex;
            out.width(8);
            out.fill('0');
            out << hash;
        }
    }

    void merge(const SparseSketch<BucketBits, HashT> &other) {
        hash_set.insert(other.hash_set.begin(), other.hash_set.end());
    }
};


/**
 * Sketch containing a fixed number of buckets
 */
template <int BucketBits = 10, typename HashT = uint32_t>
struct NormalSketch : Sketch<BucketBits, HashT> {
    using typename Sketch<BucketBits, HashT>::SketchType;
    using Sketch<BucketBits, HashT>::BUCKET_COUNT;
    using Sketch<BucketBits, HashT>::BUCKET_MASK;
    using UP = std::unique_ptr<NormalSketch>;
    enum { classId = IDENTIFIABLE_CLASSID_NS(search, NormalSketch) };

    uint8_t bucket[BUCKET_COUNT];

    NormalSketch() { memset(&bucket[0], 0, BUCKET_COUNT); }

    int aggregate(HashT hash) override {
        uint8_t existing_value = bucket[hash & BUCKET_MASK];
        uint8_t new_value = countPrefixZeros(hash | BUCKET_MASK);
        if (new_value > existing_value) {
            bucket[hash & BUCKET_MASK] = new_value;
            return new_value - existing_value;
        }
        return 0;
    }

    uint32_t compress_buckets_into(char *buffer, uint32_t size) const;
    void decompress_buckets_from(char *buffer, uint32_t size);
    [[nodiscard]] uint32_t getClassId() const override { return classId; }
    void serialize(vespalib::Serializer &os) const override;
    void deserialize(vespalib::Deserializer &is) override;

    bool operator==(const SketchType &other) const override {
        const auto *other_normal = dynamic_cast<const NormalSketch<BucketBits, HashT> *>(&other);
        if (!other_normal) {
            return false;
        }
        for (size_t i = 0; i < BUCKET_COUNT; ++i) {
            if (other_normal->bucket[i] != bucket[i]) {
                return false;
            }
        }
        return true;
    }
    bool operator==(const NormalSketch<BucketBits, HashT>& other) const {
        return operator==(static_cast<const SketchType&>(other));
    }

    void print(std::ostream &out) const override {
        for (size_t i = 0; i < BUCKET_COUNT; ++i) {
            out << " " << int(bucket[i]);
        }
    }

    void merge(const NormalSketch<BucketBits, HashT> &other) {
        std::transform(bucket, bucket + BUCKET_COUNT, other.bucket, bucket,
                       [](uint8_t a, uint8_t b) { return std::max(a, b); });
    }

    void merge(const SparseSketch<BucketBits, HashT> &other) {
        for (auto hash : other.hash_set) {
            aggregate(hash);
        }
    }
};

template <int BucketBits, typename HashT>
SparseSketch<BucketBits, HashT>::~SparseSketch() = default;

template <int BucketBits, typename HashT>
void SparseSketch<BucketBits, HashT>::
serialize(vespalib::Serializer &os) const {
    uint32_t size = hash_set.size();
    os << size;
    for (HashT hash : hash_set) {
        os << hash;
    }
}
template <int BucketBits, typename HashT>
void SparseSketch<BucketBits, HashT>::
deserialize(vespalib::Deserializer &is) {
    uint32_t size;
    is >> size;
    for (uint32_t i = 0; i < size; ++i) {
        uint32_t hash;
        is >> hash;
        aggregate(hash);
    }
}

template <int BucketBits, typename HashT>
uint32_t NormalSketch<BucketBits, HashT>::
compress_buckets_into(char *buffer, uint32_t size) const {
    vespalib::compression::CompressionConfig config(vespalib::compression::CompressionConfig::LZ4, 9, 9);
    vespalib::ConstBufferRef org(&bucket[0], BUCKET_COUNT);
    vespalib::DataBuffer compress_buffer(buffer, size);
    vespalib::compression::CompressionConfig::Type r =
        vespalib::compression::compress(config, org, compress_buffer, false);
    assert(compress_buffer.getDead() == buffer);
    if (r == vespalib::compression::CompressionConfig::LZ4) {
        assert(compress_buffer.getDataLen() < BUCKET_COUNT);
        return compress_buffer.getDataLen();
    } else {
        assert(BUCKET_COUNT <= size);
        memcpy(buffer, bucket, BUCKET_COUNT);
        return BUCKET_COUNT;
    }
}
template <int BucketBits, typename HashT>
void NormalSketch<BucketBits, HashT>::
decompress_buckets_from(char *buffer, uint32_t size) {
    if (size == BUCKET_COUNT) {  // not compressed
        memcpy(bucket, buffer, BUCKET_COUNT);
    } else {
        vespalib::ConstBufferRef compressed(buffer, size);
        vespalib::DataBuffer uncompressed(reinterpret_cast<char *>(&bucket[0]), BUCKET_COUNT);
        vespalib::compression::decompress(vespalib::compression::CompressionConfig::LZ4, BUCKET_COUNT,
                                          compressed, uncompressed, false);
    }
}
template <int BucketBits, typename HashT>
void NormalSketch<BucketBits, HashT>::
serialize(vespalib::Serializer &os) const {
    vespalib::alloc::Alloc backing(vespalib::alloc::Alloc::alloc(LZ4_compressBound(BUCKET_COUNT)));
    char * compress_array(static_cast<char *>(backing.get()));
    uint32_t size = compress_buckets_into(compress_array, backing.size());
    os << BUCKET_COUNT << size;
    for (size_t i = 0; i < size; ++i) {
        os << static_cast<uint8_t>(compress_array[i]);
    }
}
template <int BucketBits, typename HashT>
void NormalSketch<BucketBits, HashT>::
deserialize(vespalib::Deserializer &is) {
    uint32_t bucket_count, size;
    is >> bucket_count >> size;
    assert(bucket_count == BUCKET_COUNT);
    uint8_t compressed_array[BUCKET_COUNT];
    for (size_t i = 0; i < size; ++i) {
        is >> compressed_array[i];
    }
    decompress_buckets_from(reinterpret_cast<char *>(compressed_array), size);
}

}  // namespace search