summaryrefslogtreecommitdiffstats
path: root/searchlib/src/tests/datastore/unique_store/unique_store_test.cpp
blob: 4064921aac5b39a099f0972c51a64e8cdc82042f (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
267
// Copyright 2017 Yahoo Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#include <vespa/log/log.h>
LOG_SETUP("unique_store_test");
#include <vespa/vespalib/testkit/testapp.h>
#include <vespa/vespalib/test/insertion_operators.h>
#include <vespa/vespalib/util/traits.h>
#include <vespa/searchlib/datastore/unique_store.hpp>
#include <vespa/searchlib/test/datastore/memstats.h>
#include <vector>

using namespace search::datastore;
using search::MemoryUsage;
using vespalib::ArrayRef;
using generation_t = vespalib::GenerationHandler::generation_t;
using MemStats = search::datastore::test::MemStats;

template <typename EntryT, typename RefT = EntryRefT<22> >
struct Fixture
{
    using EntryRefType = RefT;
    using UniqueStoreType = UniqueStore<EntryT, RefT>;
    using UniqueStoreAddResult = typename UniqueStoreType::AddResult;
    using value_type = EntryT;
    using ReferenceStore = std::map<EntryRef, std::pair<EntryT,uint32_t>>;

    UniqueStoreType store;
    ReferenceStore refStore;
    generation_t generation;
    Fixture()
        : store(),
          refStore(),
          generation(1)
    {}
    void assertAdd(const EntryT &input) {
        EntryRef ref = add(input);
        assertGet(ref, input);
    }
    EntryRef add(const EntryT &input) {
        UniqueStoreAddResult addResult = store.add(input);
        EntryRef result = addResult.ref();
        auto insres = refStore.insert(std::make_pair(result, std::make_pair(input, 1u)));
        EXPECT_EQUAL(insres.second, addResult.inserted());
        if (!insres.second) {
            ++insres.first->second.second;
        }
        return result;
    }
    void alignRefStore(EntryRef ref, const EntryT &input, uint32_t refcnt) {
        if (refcnt > 0) {
            auto insres = refStore.insert(std::make_pair(ref, std::make_pair(input, refcnt)));
            if (!insres.second) {
                insres.first->second.second = refcnt;
            }
        } else {
            refStore.erase(ref);
        }
    }
    void assertGet(EntryRef ref, const EntryT &exp) const {
        EntryT act = store.get(ref);
        EXPECT_EQUAL(exp, act);
    }
    void remove(EntryRef ref) {
        ASSERT_EQUAL(1u, refStore.count(ref));
        store.remove(ref);
        if (refStore[ref].second > 1) {
            --refStore[ref].second;
        } else {
            refStore.erase(ref);
        }
    }
    void remove(const EntryT &input) {
        remove(getEntryRef(input));
    }
    uint32_t getBufferId(EntryRef ref) const {
        return EntryRefType(ref).bufferId();
    }
    void assertBufferState(EntryRef ref, const MemStats expStats) const {
        EXPECT_EQUAL(expStats._used, store.bufferState(ref).size());
        EXPECT_EQUAL(expStats._hold, store.bufferState(ref).getHoldElems());
        EXPECT_EQUAL(expStats._dead, store.bufferState(ref).getDeadElems());
    }
    void assertMemoryUsage(const MemStats expStats) const {
        MemoryUsage act = store.getMemoryUsage();
        EXPECT_EQUAL(expStats._used, act.usedBytes());
        EXPECT_EQUAL(expStats._hold, act.allocatedBytesOnHold());
        EXPECT_EQUAL(expStats._dead, act.deadBytes());
    }
    void assertStoreContent() const {
        for (const auto &elem : refStore) {
            TEST_DO(assertGet(elem.first, elem.second.first));
        }
    }
    EntryRef getEntryRef(const EntryT &input) {
        for (const auto &elem : refStore) {
            if (elem.second.first == input) {
                return elem.first;
            }
        }
        return EntryRef();
    }
    void trimHoldLists() {
        store.freeze();
        store.transferHoldLists(generation++);
        store.trimHoldLists(generation);
    }
    void compactWorst() {
        ICompactionContext::UP ctx = store.compactWorst();
        std::vector<EntryRef> refs;
        for (const auto &elem : refStore) {
            refs.push_back(elem.first);
        }
        refs.push_back(EntryRef());
        std::vector<EntryRef> compactedRefs = refs;
        ctx->compact(ArrayRef<EntryRef>(compactedRefs));
        ASSERT_FALSE(refs.back().valid());
        refs.pop_back();
        ReferenceStore compactedRefStore;
        for (size_t i = 0; i < refs.size(); ++i) {
            ASSERT_EQUAL(0u, compactedRefStore.count(compactedRefs[i]));
            ASSERT_EQUAL(1u, refStore.count(refs[i]));
            compactedRefStore.insert(std::make_pair(compactedRefs[i], refStore[refs[i]]));
        }
        refStore = compactedRefStore;
    }
    size_t entrySize() const { return sizeof(EntryT); }
    auto getBuilder(uint32_t uniqueValuesHint) { return store.getBuilder(uniqueValuesHint); }
    auto getSaver() { return store.getSaver(); }
};

using NumberFixture = Fixture<uint32_t>;
using StringFixture = Fixture<std::string>;
using SmallOffsetNumberFixture = Fixture<uint32_t, EntryRefT<10>>;

TEST("require that we test with trivial and non-trivial types")
{
    EXPECT_TRUE(vespalib::can_skip_destruction<NumberFixture::value_type>::value);
    EXPECT_FALSE(vespalib::can_skip_destruction<StringFixture::value_type>::value);
}

TEST_F("require that we can add and get values of trivial type", NumberFixture)
{
    TEST_DO(f.assertAdd(1));
    TEST_DO(f.assertAdd(2));
    TEST_DO(f.assertAdd(3));
    TEST_DO(f.assertAdd(1));
}

TEST_F("require that we can add and get values of non-trivial type", StringFixture)
{
    TEST_DO(f.assertAdd("aa"));
    TEST_DO(f.assertAdd("bbb"));
    TEST_DO(f.assertAdd("ccc"));
    TEST_DO(f.assertAdd("aa"));
}

TEST_F("require that elements are put on hold when value is removed", NumberFixture)
{
    EntryRef ref = f.add(1);
    // Note: The first buffer have the first element reserved -> we expect 2 elements used here.
    TEST_DO(f.assertBufferState(ref, MemStats().used(2).hold(0).dead(1)));
    f.store.remove(ref);
    TEST_DO(f.assertBufferState(ref, MemStats().used(2).hold(1).dead(1)));
}

TEST_F("require that elements are reference counted", NumberFixture)
{
    EntryRef ref = f.add(1);
    EntryRef ref2 = f.add(1);
    EXPECT_EQUAL(ref.ref(), ref2.ref());
    // Note: The first buffer have the first element reserved -> we expect 2 elements used here.
    TEST_DO(f.assertBufferState(ref, MemStats().used(2).hold(0).dead(1)));
    f.store.remove(ref);
    TEST_DO(f.assertBufferState(ref, MemStats().used(2).hold(0).dead(1)));
    f.store.remove(ref);
    TEST_DO(f.assertBufferState(ref, MemStats().used(2).hold(1).dead(1)));
}

TEST_F("require that new underlying buffer is allocated when current is full", SmallOffsetNumberFixture)
{
    uint32_t firstBufferId = f.getBufferId(f.add(1));
    for (uint32_t i = 0; i < (F1::EntryRefType::offsetSize() - 2); ++i) {
        uint32_t bufferId = f.getBufferId(f.add(i + 2));
        EXPECT_EQUAL(firstBufferId, bufferId);
    }
    TEST_DO(f.assertStoreContent());

    uint32_t bias = F1::EntryRefType::offsetSize();
    uint32_t secondBufferId = f.getBufferId(f.add(bias + 1));
    EXPECT_NOT_EQUAL(firstBufferId, secondBufferId);
    for (uint32_t i = 0; i < 10u; ++i) {
        uint32_t bufferId = f.getBufferId(f.add(bias + i + 2));
        EXPECT_EQUAL(secondBufferId, bufferId);
    }
    TEST_DO(f.assertStoreContent());
}

TEST_F("require that compaction works", NumberFixture)
{
    EntryRef val1Ref = f.add(1);
    EntryRef val2Ref = f.add(2);
    f.remove(f.add(4));
    f.trimHoldLists();
    TEST_DO(f.assertBufferState(val1Ref, MemStats().used(4).dead(2))); // Note: First element is reserved
    uint32_t val1BufferId = f.getBufferId(val1Ref);

    EXPECT_EQUAL(2u, f.refStore.size());
    f.compactWorst();
    EXPECT_EQUAL(2u, f.refStore.size());
    TEST_DO(f.assertStoreContent());

    // Buffer has been compacted
    EXPECT_NOT_EQUAL(val1BufferId, f.getBufferId(f.getEntryRef(1)));
    // Old ref should still point to data.
    f.assertGet(val1Ref, 1);
    f.assertGet(val2Ref, 2);
    EXPECT_TRUE(f.store.bufferState(val1Ref).isOnHold());
    f.trimHoldLists();
    EXPECT_TRUE(f.store.bufferState(val1Ref).isFree());
    TEST_DO(f.assertStoreContent());
}

TEST_F("require that builder works", NumberFixture)
{
    auto builder = f.getBuilder(2);
    builder.add(10);
    builder.add(20);
    builder.setupRefCounts();
    EntryRef val10Ref = builder.mapEnumValueToEntryRef(1);
    EntryRef val20Ref = builder.mapEnumValueToEntryRef(2);
    TEST_DO(f.assertBufferState(val10Ref, MemStats().used(3).dead(1))); // Note: First element is reserved
    EXPECT_TRUE(val10Ref.valid());
    EXPECT_TRUE(val20Ref.valid());
    EXPECT_NOT_EQUAL(val10Ref.ref(), val20Ref.ref());
    f.assertGet(val10Ref, 10);
    f.assertGet(val20Ref, 20);
    builder.makeDictionary();
    // Align refstore with the two entries added by builder.
    f.alignRefStore(val10Ref, 10, 1);
    f.alignRefStore(val20Ref, 20, 1);
    EXPECT_EQUAL(val10Ref.ref(), f.add(10).ref());
    EXPECT_EQUAL(val20Ref.ref(), f.add(20).ref());
}

TEST_F("require that saver works", NumberFixture)
{
    EntryRef val10Ref = f.add(10);
    EntryRef val20Ref = f.add(20);
    f.remove(f.add(40));
    f.trimHoldLists();

    auto saver = f.getSaver();
    std::vector<uint32_t> refs;
    saver.foreach_key([&](EntryRef ref) { refs.push_back(ref.ref()); });
    std::vector<uint32_t> expRefs;
    expRefs.push_back(val10Ref.ref());
    expRefs.push_back(val20Ref.ref());
    EXPECT_EQUAL(expRefs, refs);
    saver.enumerateValues();
    uint32_t invalidEnum = saver.mapEntryRefToEnumValue(EntryRef());
    uint32_t enumValue10 = saver.mapEntryRefToEnumValue(val10Ref);
    uint32_t enumValue20 = saver.mapEntryRefToEnumValue(val20Ref);
    EXPECT_EQUAL(0u, invalidEnum);
    EXPECT_EQUAL(1u, enumValue10);
    EXPECT_EQUAL(2u, enumValue20);
}

TEST_MAIN() { TEST_RUN_ALL(); }