summaryrefslogtreecommitdiffstats
path: root/searchlib/src/tests/tensor/hnsw_saver/hnsw_save_load_test.cpp
blob: add7801e03a99faf6a653c307feb8e33c663c279 (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
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#include <vespa/searchlib/tensor/hnsw_graph.h>
#include <vespa/searchlib/tensor/hnsw_index_saver.h>
#include <vespa/searchlib/tensor/hnsw_index_loader.hpp>
#include <vespa/searchlib/util/bufferwriter.h>
#include <vespa/searchlib/util/fileutil.h>
#include <vespa/vespalib/gtest/gtest.h>
#include <vector>

#include <vespa/log/log.h>
LOG_SETUP("hnsw_save_load_test");

using namespace search::tensor;
using search::BufferWriter;
using search::fileutil::LoadedBuffer;

class VectorBufferWriter : public BufferWriter {
private:
    char tmp[1024];
public:
    std::vector<char> output;
    VectorBufferWriter() {
        setup(tmp, 1024);
    }
    ~VectorBufferWriter() {}
    void flush() override {
        for (size_t i = 0; i < usedLen(); ++i) {
            output.push_back(tmp[i]);
        }
        rewind();
    }
};

class VectorBufferReader {
private:
    const std::vector<char>& _data;
    size_t _pos;

public:
    VectorBufferReader(const std::vector<char>& data) : _data(data), _pos(0) {}
    uint32_t readHostOrder() {
        uint32_t result = 0;
        assert(_pos + sizeof(uint32_t) <= _data.size());
        std::memcpy(&result, _data.data() + _pos, sizeof(uint32_t));
        _pos += sizeof(uint32_t);
        return result;
    }
};

using V = std::vector<uint32_t>;

void populate(HnswGraph &graph) {
    // no 0
    graph.make_node_for_document(1, 1);
    auto er = graph.make_node_for_document(2, 2);
    // no 3
    graph.make_node_for_document(4, 2);
    graph.make_node_for_document(5, 0);
    graph.make_node_for_document(6, 1);

    graph.set_link_array(1, 0, V{2, 4, 6});
    graph.set_link_array(2, 0, V{1, 4, 6});
    graph.set_link_array(4, 0, V{1, 2, 6});
    graph.set_link_array(6, 0, V{1, 2, 4});
    graph.set_link_array(2, 1, V{4});
    graph.set_link_array(4, 1, V{2});
    graph.set_entry_node({2, er, 1});
}

void modify(HnswGraph &graph) {
    graph.remove_node_for_document(2);
    graph.remove_node_for_document(6);
    graph.make_node_for_document(7, 2);

    graph.set_link_array(1, 0, V{7, 4});
    graph.set_link_array(4, 0, V{7, 2});
    graph.set_link_array(7, 0, V{4, 2});
    graph.set_link_array(4, 1, V{7});
    graph.set_link_array(7, 1, V{4});

    graph.set_entry_node({4, graph.get_node_ref(4), 1});
}


class CopyGraphTest : public ::testing::Test {
public:
    HnswGraph original;
    HnswGraph copy;

    void expect_empty_d(uint32_t docid) const {
        EXPECT_FALSE(copy.acquire_node_ref(docid).valid());
    }

    void expect_level_0(uint32_t docid, const V& exp_links) const {
        auto levels = copy.acquire_level_array(docid);
        EXPECT_GE(levels.size(), 1);
        auto links = copy.acquire_link_array(docid, 0);
        EXPECT_EQ(exp_links.size(), links.size());
        for (size_t i = 0; i < exp_links.size() && i < links.size(); ++i) {
            EXPECT_EQ(exp_links[i], links[i]);
        }
    }

    void expect_level_1(uint32_t docid, const V& exp_links) const {
        auto levels = copy.acquire_level_array(docid);
        EXPECT_EQ(2, levels.size());
        auto links = copy.acquire_link_array(docid, 1);
        EXPECT_EQ(exp_links.size(), links.size());
        for (size_t i = 0; i < exp_links.size() && i < links.size(); ++i) {
            EXPECT_EQ(exp_links[i], links[i]);
        }
    }

    std::vector<char> save_original() const {
        HnswIndexSaver saver(original);
        VectorBufferWriter vector_writer;
        saver.save(vector_writer);
        return vector_writer.output;
    }
    void load_copy(std::vector<char> data) {
        HnswIndexLoader<VectorBufferReader> loader(copy, std::make_unique<VectorBufferReader>(data));
        while (loader.load_next()) {}
    }

    void expect_copy_as_populated() const {
        EXPECT_EQ(copy.size(), 7);
        auto entry = copy.get_entry_node();
        EXPECT_EQ(entry.docid, 2);
        EXPECT_EQ(entry.level, 1);

        expect_empty_d(0);
        expect_empty_d(3);
        expect_empty_d(5);

        expect_level_0(1, {2, 4, 6});
        expect_level_0(2, {1, 4, 6});
        expect_level_0(4, {1, 2, 6});
        expect_level_0(6, {1, 2, 4});
        
        expect_level_1(2, {4});
        expect_level_1(4, {2});
    }
};

TEST_F(CopyGraphTest, reconstructs_graph)
{
    populate(original);
    auto data = save_original();
    load_copy(data);
    expect_copy_as_populated();
}

TEST_F(CopyGraphTest, later_changes_ignored)
{
    populate(original);
    HnswIndexSaver saver(original);
    modify(original);
    VectorBufferWriter vector_writer;
    saver.save(vector_writer);
    auto data = vector_writer.output;
    load_copy(data);
    expect_copy_as_populated();
}

GTEST_MAIN_RUN_ALL_TESTS()