aboutsummaryrefslogtreecommitdiffstats
path: root/vespalib/src/vespa/vespalib/btree/btreenodestore.h
blob: ba316465d90a2490e98a8bcd671d308e9d857a43 (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
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#pragma once

#include "btreenode.h"
#include "btreetraits.h"
#include <vespa/vespalib/datastore/datastore.h>

namespace vespalib::datastore { class CompactingBuffers; }

namespace vespalib::btree {

class BTreeNodeReclaimer
{
public:
    static void reclaim(BTreeNode * node) {
        node->unFreeze();
    }
};

template <typename ToFreeze>
struct FrozenBtreeNode : public ToFreeze {
    FrozenBtreeNode() : ToFreeze() { this->freeze(); }
};

template <typename EntryType>
class BTreeNodeBufferType : public datastore::BufferType<EntryType, FrozenBtreeNode<EntryType>>
{
    using ParentType = datastore::BufferType<EntryType, FrozenBtreeNode<EntryType>>;
    using ParentType::empty_entry;
    using ParentType::_arraySize;
    using EntryCount = typename ParentType::EntryCount;
    using CleanContext = typename ParentType::CleanContext;
public:
    BTreeNodeBufferType(uint32_t min_entries, uint32_t max_entries)
        : ParentType(1, min_entries, max_entries)
    { }

    void initialize_reserved_entries(void *buffer, EntryCount reserved_entries) override;

    void clean_hold(void *buffer, size_t offset, EntryCount num_entries, CleanContext cleanCtx) override;
};


template <typename KeyT,
          typename DataT,
          typename AggrT,
          size_t INTERNAL_SLOTS,
          size_t LEAF_SLOTS>
class BTreeNodeStore
{
public:
    using DataStoreType = datastore::DataStoreT<datastore::EntryRefT<22> >;
    using RefType = DataStoreType::RefType;
    using InternalNodeType = BTreeInternalNode<KeyT, AggrT, INTERNAL_SLOTS>;
    using LeafNodeType = BTreeLeafNode<KeyT, DataT, AggrT, LEAF_SLOTS>;
    using InternalNodeTypeRefPair = typename InternalNodeType::RefPair;
    using LeafNodeTypeRefPair = typename LeafNodeType::RefPair;
    using generation_t = vespalib::GenerationHandler::generation_t;
    using EntryRef = datastore::EntryRef;
    using CompactionStrategy = datastore::CompactionStrategy;

    enum NodeTypes
    {
        NODETYPE_INTERNAL = 0,
        NODETYPE_LEAF = 1
    };


private:
    static constexpr size_t MIN_BUFFER_ARRAYS = 128u;
    DataStoreType _store;
    BTreeNodeBufferType<InternalNodeType> _internalNodeType;
    BTreeNodeBufferType<LeafNodeType> _leafNodeType;

public:
    BTreeNodeStore();

    ~BTreeNodeStore();

    void disableFreeLists() { _store.disableFreeLists(); }
    void disable_entry_hold_list() { _store.disable_entry_hold_list(); }

    static bool isValidRef(EntryRef ref) { return ref.valid(); }

    bool isLeafRef(EntryRef ref) const {
        RefType iRef(ref);
        return _store.getTypeId(iRef.bufferId()) == NODETYPE_LEAF;
    }

    const InternalNodeType *mapInternalRef(EntryRef ref) const {
        RefType iRef(ref);
        return _store.getEntry<InternalNodeType>(iRef);
    }

    InternalNodeType *mapInternalRef(EntryRef ref) {
        RefType iRef(ref);
        return _store.getEntry<InternalNodeType>(iRef);
    }

    const LeafNodeType *mapLeafRef(EntryRef ref) const {
        RefType iRef(ref);
        return _store.getEntry<LeafNodeType>(iRef);
    }

    LeafNodeType *mapLeafRef(EntryRef ref) {
        RefType iRef(ref);
        return _store.getEntry<LeafNodeType>(iRef);
    }

    template <typename NodeType>
    const NodeType *mapRef(EntryRef ref) const {
        RefType iRef(ref);
        return _store.getEntry<NodeType>(iRef);
    }

    template <typename NodeType>
    NodeType *mapRef(EntryRef ref) {
        RefType iRef(ref);
        return _store.getEntry<NodeType>(iRef);
    }

    LeafNodeTypeRefPair allocNewLeafNode() {
        return _store.allocator<LeafNodeType>(NODETYPE_LEAF).alloc();
    }

    LeafNodeTypeRefPair allocLeafNode() {
        return _store.freeListAllocator<LeafNodeType, BTreeNodeReclaimer>(NODETYPE_LEAF).alloc();
    }

    LeafNodeTypeRefPair allocNewLeafNodeCopy(const LeafNodeType &rhs) {
        return _store.allocator<LeafNodeType>(NODETYPE_LEAF).alloc(rhs);
    }

    LeafNodeTypeRefPair allocLeafNodeCopy(const LeafNodeType &rhs) {
        return _store.freeListAllocator<LeafNodeType, BTreeNodeReclaimer>(NODETYPE_LEAF).alloc(rhs);
    }

    InternalNodeTypeRefPair allocNewInternalNode() {
        return _store.allocator<InternalNodeType>(NODETYPE_INTERNAL).alloc();
    }

    InternalNodeTypeRefPair allocInternalNode() {
        return _store.freeListAllocator<InternalNodeType, BTreeNodeReclaimer>(NODETYPE_INTERNAL).alloc();
    }

    InternalNodeTypeRefPair allocNewInternalNodeCopy(const InternalNodeType &rhs) {
        return _store.allocator<InternalNodeType>(NODETYPE_INTERNAL).alloc(rhs);
    }

    InternalNodeTypeRefPair allocInternalNodeCopy(const InternalNodeType &rhs) {
        return _store.freeListAllocator<InternalNodeType, BTreeNodeReclaimer>(NODETYPE_INTERNAL).alloc(rhs);
    }

    void hold_entry(EntryRef ref) {
        _store.hold_entry(ref);
    }

    std::unique_ptr<vespalib::datastore::CompactingBuffers> start_compact_worst(const CompactionStrategy& compaction_strategy);

    void assign_generation(generation_t current_gen) {
        _store.assign_generation(current_gen);
    }

    // Inherit doc from DataStoreBase
    datastore::MemoryStats getMemStats() const {
        return _store.getMemStats();
    }

    // Inherit doc from DataStoreBase
    void reclaim_memory(generation_t oldest_used_gen) {
        _store.reclaim_memory(oldest_used_gen);
    }

    void reclaim_all_memory() {
        _store.reclaim_all_memory();
    }

    // Inherit doc from DataStoreBase
    vespalib::MemoryUsage getMemoryUsage() const {
        return _store.getMemoryUsage();
    }

    // Inherit doc from DataStoreT
    bool getCompacting(EntryRef ref) {
        return _store.getCompacting(ref);
    }

    bool has_held_buffers() const {
        return _store.has_held_buffers();
    }

    template <typename FunctionType>
    void foreach_key(EntryRef ref, FunctionType func) const {
        if (!ref.valid())
            return;
        if (isLeafRef(ref)) {
            mapLeafRef(ref)->foreach_key(func);
        } else {
            mapInternalRef(ref)->foreach_key(*this, func);
        }
    }

    template <typename FunctionType>
    void foreach(EntryRef ref, FunctionType func) const {
        if (!ref.valid())
            return;
        if (isLeafRef(ref)) {
            mapLeafRef(ref)->foreach(func);
        } else {
            mapInternalRef(ref)->foreach(*this, func);
        }
    }
};

extern template class BTreeNodeStore<uint32_t, uint32_t, NoAggregated,
                                     BTreeDefaultTraits::INTERNAL_SLOTS,
                                     BTreeDefaultTraits::LEAF_SLOTS>;
extern template class BTreeNodeStore<uint32_t, BTreeNoLeafData, NoAggregated,
                                     BTreeDefaultTraits::INTERNAL_SLOTS,
                                     BTreeDefaultTraits::LEAF_SLOTS>;
extern template class BTreeNodeStore<uint32_t, int32_t, MinMaxAggregated,
                                     BTreeDefaultTraits::INTERNAL_SLOTS,
                                     BTreeDefaultTraits::LEAF_SLOTS>;

extern template class BTreeNodeBufferType<BTreeInternalNode<uint32_t, NoAggregated, BTreeDefaultTraits::INTERNAL_SLOTS>>;
extern template class BTreeNodeBufferType<BTreeInternalNode<uint32_t, MinMaxAggregated, BTreeDefaultTraits::INTERNAL_SLOTS>>;

extern template class BTreeNodeBufferType<BTreeLeafNode<uint32_t, uint32_t, NoAggregated, BTreeDefaultTraits::LEAF_SLOTS>>;
extern template class BTreeNodeBufferType<BTreeLeafNode<uint32_t, BTreeNoLeafData, NoAggregated, BTreeDefaultTraits::LEAF_SLOTS>>;
extern template class BTreeNodeBufferType<BTreeLeafNode<uint32_t, int32_t, MinMaxAggregated, BTreeDefaultTraits::LEAF_SLOTS>>;

}

namespace vespalib::datastore {

using namespace btree;

extern template class BufferType<BTreeInternalNode<uint32_t, NoAggregated, BTreeDefaultTraits::INTERNAL_SLOTS>,
                                 FrozenBtreeNode<BTreeInternalNode<uint32_t, NoAggregated, BTreeDefaultTraits::INTERNAL_SLOTS>>>;
extern template class BufferType<BTreeInternalNode<uint32_t, MinMaxAggregated, BTreeDefaultTraits::INTERNAL_SLOTS>,
                                 FrozenBtreeNode<BTreeInternalNode<uint32_t, MinMaxAggregated, BTreeDefaultTraits::INTERNAL_SLOTS>>>;

extern template class BufferType<BTreeLeafNode<uint32_t, uint32_t, NoAggregated, BTreeDefaultTraits::LEAF_SLOTS>,
                                 FrozenBtreeNode<BTreeLeafNode<uint32_t, uint32_t, NoAggregated, BTreeDefaultTraits::LEAF_SLOTS>>>;
extern template class BufferType<BTreeLeafNode<uint32_t, BTreeNoLeafData, NoAggregated, BTreeDefaultTraits::LEAF_SLOTS>,
                                 FrozenBtreeNode<BTreeLeafNode<uint32_t, BTreeNoLeafData, NoAggregated, BTreeDefaultTraits::LEAF_SLOTS>>>;
extern template class BufferType<BTreeLeafNode<uint32_t, int32_t, MinMaxAggregated, BTreeDefaultTraits::LEAF_SLOTS>,
                                 FrozenBtreeNode<BTreeLeafNode<uint32_t, int32_t, MinMaxAggregated, BTreeDefaultTraits::LEAF_SLOTS>>>;

}