/
multitree.go
420 lines (368 loc) · 10.7 KB
/
multitree.go
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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
package memiavl
import (
"context"
stderrors "errors"
"fmt"
"math"
"os"
"path/filepath"
"sort"
"cosmossdk.io/errors"
storetypes "github.com/cosmos/cosmos-sdk/store/types"
"github.com/cosmos/iavl"
"github.com/tidwall/wal"
"golang.org/x/exp/slices"
"golang.org/x/sync/errgroup"
)
const MetadataFileName = "__metadata"
type namedTree struct {
tree *Tree
name string
}
// MultiTree manages multiple memiavl tree together,
// all the trees share the same latest version, the snapshots are always created at the same version.
//
// The snapshot structure is like this:
// ```
// > snapshot-V
// > metadata
// > bank
// > kvs
// > nodes
// > metadata
// > acc
// > other stores...
// ```
type MultiTree struct {
// if the tree is start from genesis, it's the initial version of the chain,
// if the tree is imported from snapshot, it's the imported version plus one,
// it always corresponds to the wal entry with index 1.
initialVersion uint32
zeroCopy bool
trees []namedTree
treesByName map[string]int // reversed index of the trees
lastCommitInfo storetypes.CommitInfo
// the initial metadata loaded from disk snapshot
metadata MultiTreeMetadata
}
func NewEmptyMultiTree(initialVersion uint32) *MultiTree {
return &MultiTree{
initialVersion: initialVersion,
treesByName: make(map[string]int),
zeroCopy: true,
}
}
func LoadMultiTree(dir string, zeroCopy bool) (*MultiTree, error) {
// load commit info
bz, err := os.ReadFile(filepath.Join(dir, MetadataFileName))
if err != nil {
return nil, err
}
var metadata MultiTreeMetadata
if err := metadata.Unmarshal(bz); err != nil {
return nil, err
}
if metadata.CommitInfo.Version > math.MaxUint32 {
return nil, fmt.Errorf("commit info version overflows uint32: %d", metadata.CommitInfo.Version)
}
if metadata.InitialVersion > math.MaxUint32 {
return nil, fmt.Errorf("initial version overflows uint32: %d", metadata.InitialVersion)
}
entries, err := os.ReadDir(dir)
if err != nil {
return nil, err
}
treeMap := make(map[string]*Tree, len(entries))
treeNames := make([]string, 0, len(entries))
for _, e := range entries {
if !e.IsDir() {
continue
}
name := e.Name()
treeNames = append(treeNames, name)
snapshot, err := OpenSnapshot(filepath.Join(dir, name))
if err != nil {
return nil, err
}
treeMap[name] = NewFromSnapshot(snapshot, zeroCopy)
}
sort.Strings(treeNames)
trees := make([]namedTree, len(treeNames))
treesByName := make(map[string]int, len(trees))
for i, name := range treeNames {
tree := treeMap[name]
trees[i] = namedTree{tree: tree, name: name}
treesByName[name] = i
}
mtree := &MultiTree{
trees: trees,
treesByName: treesByName,
lastCommitInfo: *metadata.CommitInfo,
metadata: metadata,
zeroCopy: zeroCopy,
}
// initial version is nesserary for wal index conversion
mtree.setInitialVersion(metadata.InitialVersion)
return mtree, nil
}
// TreeByName returns the tree by name, returns nil if not found
func (t *MultiTree) TreeByName(name string) *Tree {
if i, ok := t.treesByName[name]; ok {
return t.trees[i].tree
}
return nil
}
func (t *MultiTree) SetInitialVersion(initialVersion int64) error {
if initialVersion >= math.MaxUint32 {
return fmt.Errorf("version overflows uint32: %d", initialVersion)
}
if t.Version() != 0 {
return fmt.Errorf("multi tree is not empty: %d", t.Version())
}
for _, entry := range t.trees {
if !entry.tree.IsEmpty() {
return fmt.Errorf("tree is not empty: %s", entry.name)
}
}
t.setInitialVersion(initialVersion)
return nil
}
func (t *MultiTree) setInitialVersion(initialVersion int64) {
t.initialVersion = uint32(initialVersion)
for _, entry := range t.trees {
entry.tree.initialVersion = t.initialVersion
}
}
func (t *MultiTree) SetZeroCopy(zeroCopy bool) {
t.zeroCopy = zeroCopy
for _, entry := range t.trees {
entry.tree.SetZeroCopy(zeroCopy)
}
}
// Copy returns a snapshot of the tree which won't be corrupted by further modifications on the main tree.
func (t *MultiTree) Copy() *MultiTree {
trees := make([]namedTree, len(t.trees))
treesByName := make(map[string]int, len(t.trees))
for i, entry := range t.trees {
tree := entry.tree.Copy()
trees[i] = namedTree{tree: tree, name: entry.name}
treesByName[entry.name] = i
}
clone := *t
clone.trees = trees
clone.treesByName = treesByName
return &clone
}
func (t *MultiTree) Hash() []byte {
return t.lastCommitInfo.Hash()
}
func (t *MultiTree) Version() int64 {
return t.lastCommitInfo.Version
}
func (t *MultiTree) LastCommitInfo() *storetypes.CommitInfo {
return &t.lastCommitInfo
}
// ApplyUpgrades store name upgrades
func (t *MultiTree) ApplyUpgrades(upgrades []*TreeNameUpgrade) error {
if len(upgrades) == 0 {
return nil
}
t.treesByName = nil // rebuild in the end
for _, upgrade := range upgrades {
switch {
case upgrade.Delete:
i := slices.IndexFunc(t.trees, func(entry namedTree) bool {
return entry.name == upgrade.Name
})
if i < 0 {
return fmt.Errorf("unknown tree name %s", upgrade.Name)
}
// swap deletion
t.trees[i], t.trees[len(t.trees)-1] = t.trees[len(t.trees)-1], t.trees[i]
t.trees = t.trees[:len(t.trees)-1]
case upgrade.RenameFrom != "":
// rename tree
i := slices.IndexFunc(t.trees, func(entry namedTree) bool {
return entry.name == upgrade.RenameFrom
})
if i < 0 {
return fmt.Errorf("unknown tree name %s", upgrade.RenameFrom)
}
t.trees[i].name = upgrade.Name
default:
// add tree
tree := NewWithInitialVersion(uint32(nextVersion(t.Version(), t.initialVersion)))
t.trees = append(t.trees, namedTree{tree: tree, name: upgrade.Name})
}
}
sort.SliceStable(t.trees, func(i, j int) bool {
return t.trees[i].name < t.trees[j].name
})
t.treesByName = make(map[string]int, len(t.trees))
for i, tree := range t.trees {
if _, ok := t.treesByName[tree.name]; ok {
return fmt.Errorf("memiavl tree name conflicts: %s", tree.name)
}
t.treesByName[tree.name] = i
}
return nil
}
// ApplyChangeSet applies change sets for all trees.
// if `updateCommitInfo` is `false`, the `lastCommitInfo.StoreInfos` is dirty.
func (t *MultiTree) ApplyChangeSet(changeSets []*NamedChangeSet, updateCommitInfo bool) ([]byte, int64, error) {
version := nextVersion(t.lastCommitInfo.Version, t.initialVersion)
var (
infos []storetypes.StoreInfo
csIndex int
)
for _, entry := range t.trees {
var changeSet iavl.ChangeSet
if csIndex < len(changeSets) && entry.name == changeSets[csIndex].Name {
changeSet = changeSets[csIndex].Changeset
csIndex++
}
hash, v, err := entry.tree.ApplyChangeSet(changeSet, updateCommitInfo)
if err != nil {
return nil, 0, err
}
if v != version {
return nil, 0, fmt.Errorf("multi tree version don't match(%d != %d)", v, version)
}
if updateCommitInfo {
infos = append(infos, storetypes.StoreInfo{
Name: entry.name,
CommitId: storetypes.CommitID{
Version: v,
Hash: hash,
},
})
}
}
if csIndex != len(changeSets) {
return nil, 0, fmt.Errorf("non-exhaustive change sets")
}
t.lastCommitInfo.Version = version
t.lastCommitInfo.StoreInfos = infos
var hash []byte
if updateCommitInfo {
hash = t.lastCommitInfo.Hash()
}
return hash, t.lastCommitInfo.Version, nil
}
// UpdateCommitInfo update lastCommitInfo based on current status of trees.
// it's needed if `updateCommitInfo` is set to `false` in `ApplyChangeSet`.
func (t *MultiTree) UpdateCommitInfo() []byte {
var infos []storetypes.StoreInfo
for _, entry := range t.trees {
infos = append(infos, storetypes.StoreInfo{
Name: entry.name,
CommitId: storetypes.CommitID{
Version: entry.tree.Version(),
Hash: entry.tree.RootHash(),
},
})
}
t.lastCommitInfo.StoreInfos = infos
return t.lastCommitInfo.Hash()
}
// CatchupWAL replay the new entries in the WAL on the tree to catch-up to the target or latest version.
func (t *MultiTree) CatchupWAL(wal *wal.Log, endVersion int64) error {
lastIndex, err := wal.LastIndex()
if err != nil {
return errors.Wrap(err, "read wal last index failed")
}
firstIndex := walIndex(nextVersion(t.Version(), t.initialVersion), t.initialVersion)
if firstIndex > lastIndex {
// already up-to-date
return nil
}
endIndex := lastIndex
if endVersion != 0 {
endIndex = walIndex(endVersion, t.initialVersion)
if endIndex > lastIndex || endIndex < firstIndex {
return fmt.Errorf("endIndex %d not in valid range: [%d, %d]", endIndex, firstIndex, lastIndex)
}
}
for i := firstIndex; i <= endIndex; i++ {
bz, err := wal.Read(i)
if err != nil {
return errors.Wrap(err, "read wal log failed")
}
var entry WALEntry
if err := entry.Unmarshal(bz); err != nil {
return errors.Wrap(err, "unmarshal wal log failed")
}
if err := t.ApplyUpgrades(entry.Upgrades); err != nil {
return errors.Wrap(err, "replay store upgrades failed")
}
if _, _, err := t.ApplyChangeSet(entry.Changesets, false); err != nil {
return errors.Wrap(err, "replay change set failed")
}
}
t.UpdateCommitInfo()
return nil
}
func (t *MultiTree) WriteSnapshot(dir string) error {
if err := os.MkdirAll(dir, os.ModePerm); err != nil {
return err
}
// write the snapshots in parallel
g, _ := errgroup.WithContext(context.Background())
for _, entry := range t.trees {
tree, name := entry.tree, entry.name // https://github.com/golang/go/wiki/CommonMistakes#using-goroutines-on-loop-iterator-variables
g.Go(func() error {
return tree.WriteSnapshot(filepath.Join(dir, name), false)
})
}
if err := g.Wait(); err != nil {
return err
}
// write commit info
metadata := MultiTreeMetadata{
CommitInfo: &t.lastCommitInfo,
InitialVersion: int64(t.initialVersion),
}
bz, err := metadata.Marshal()
if err != nil {
return err
}
return WriteFileSync(filepath.Join(dir, MetadataFileName), bz)
}
// WriteFileSync calls `f.Sync` after before closing the file
func WriteFileSync(name string, data []byte) error {
f, err := os.OpenFile(name, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, os.ModePerm)
if err != nil {
return err
}
_, err = f.Write(data)
if err == nil {
err = f.Sync()
}
if err1 := f.Close(); err1 != nil && err == nil {
err = err1
}
return err
}
func (t *MultiTree) Close() error {
errs := make([]error, 0, len(t.trees))
for _, entry := range t.trees {
errs = append(errs, entry.tree.Close())
}
t.trees = nil
t.treesByName = nil
t.lastCommitInfo = storetypes.CommitInfo{}
return stderrors.Join(errs...)
}
func nextVersion(v int64, initialVersion uint32) int64 {
if v == 0 && initialVersion > 1 {
return int64(initialVersion)
}
return v + 1
}
// walIndex converts version to wal index based on initial version
func walIndex(v int64, initialVersion uint32) uint64 {
if initialVersion > 1 {
return uint64(v) - uint64(initialVersion) + 1
}
return uint64(v)
}