/
store.go
623 lines (523 loc) · 17.4 KB
/
store.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
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
package rootmulti
import (
"fmt"
"io"
"math"
"sort"
"strings"
"cosmossdk.io/errors"
protoio "github.com/gogo/protobuf/io"
abci "github.com/tendermint/tendermint/abci/types"
"github.com/tendermint/tendermint/libs/log"
dbm "github.com/tendermint/tm-db"
pruningtypes "github.com/cosmos/cosmos-sdk/pruning/types"
snapshottypes "github.com/cosmos/cosmos-sdk/snapshots/types"
"github.com/cosmos/cosmos-sdk/store/cachemulti"
"github.com/cosmos/cosmos-sdk/store/listenkv"
"github.com/cosmos/cosmos-sdk/store/mem"
"github.com/cosmos/cosmos-sdk/store/rootmulti"
"github.com/cosmos/cosmos-sdk/store/transient"
"github.com/cosmos/cosmos-sdk/store/types"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
"github.com/crypto-org-chain/cronos/memiavl"
"github.com/crypto-org-chain/cronos/store/memiavlstore"
)
const CommitInfoFileName = "commit_infos"
var (
_ types.CommitMultiStore = (*Store)(nil)
_ types.Queryable = (*Store)(nil)
)
type Store struct {
dir string
db *memiavl.DB
logger log.Logger
// to keep it comptaible with cosmos-sdk 0.46, merge the memstores into commit info
lastCommitInfo *types.CommitInfo
storesParams map[types.StoreKey]storeParams
keysByName map[string]types.StoreKey
stores map[types.StoreKey]types.CommitKVStore
listeners map[types.StoreKey][]types.WriteListener
opts memiavl.Options
// sdk46Compact defines if the root hash is compatible with cosmos-sdk 0.46 and before.
sdk46Compact bool
}
func NewStore(dir string, logger log.Logger, sdk46Compact bool) *Store {
return &Store{
dir: dir,
logger: logger,
sdk46Compact: sdk46Compact,
storesParams: make(map[types.StoreKey]storeParams),
keysByName: make(map[string]types.StoreKey),
stores: make(map[types.StoreKey]types.CommitKVStore),
listeners: make(map[types.StoreKey][]types.WriteListener),
}
}
// flush writes all the pending change sets to memiavl tree.
func (rs *Store) flush() error {
var changeSets []*memiavl.NamedChangeSet
for key := range rs.stores {
// it'll unwrap the inter-block cache
store := rs.GetCommitKVStore(key)
if memiavlStore, ok := store.(*memiavlstore.Store); ok {
cs := memiavlStore.PopChangeSet()
if len(cs.Pairs) > 0 {
changeSets = append(changeSets, &memiavl.NamedChangeSet{
Name: key.Name(),
Changeset: cs,
})
}
}
}
sort.SliceStable(changeSets, func(i, j int) bool {
return changeSets[i].Name < changeSets[j].Name
})
return rs.db.ApplyChangeSets(changeSets)
}
// WorkingHash returns the app hash of the working tree,
//
// Implements interface Committer.
func (rs *Store) WorkingHash() []byte {
if err := rs.flush(); err != nil {
panic(err)
}
commitInfo := rs.db.WorkingCommitInfo()
if rs.sdk46Compact {
commitInfo = amendCommitInfo(commitInfo, rs.storesParams)
}
return commitInfo.Hash()
}
// Implements interface Committer
func (rs *Store) Commit() types.CommitID {
if err := rs.flush(); err != nil {
panic(err)
}
for _, store := range rs.stores {
if store.GetStoreType() != types.StoreTypeIAVL {
_ = store.Commit()
}
}
_, _, err := rs.db.Commit()
if err != nil {
panic(err)
}
// the underlying memiavl tree might be reloaded, update the tree.
for key := range rs.stores {
store := rs.stores[key]
if store.GetStoreType() == types.StoreTypeIAVL {
store.(*memiavlstore.Store).SetTree(rs.db.TreeByName(key.Name()))
}
}
rs.lastCommitInfo = rs.db.LastCommitInfo()
if rs.sdk46Compact {
rs.lastCommitInfo = amendCommitInfo(rs.lastCommitInfo, rs.storesParams)
}
return rs.lastCommitInfo.CommitID()
}
func (rs *Store) Close() error {
return rs.db.Close()
}
// Implements interface Committer
func (rs *Store) LastCommitID() types.CommitID {
if rs.lastCommitInfo == nil {
v, err := memiavl.GetLatestVersion(rs.dir)
if err != nil {
panic(fmt.Errorf("failed to get latest version: %w", err))
}
return types.CommitID{Version: v}
}
return rs.lastCommitInfo.CommitID()
}
// Implements interface Committer
func (rs *Store) SetPruning(pruningtypes.PruningOptions) {
}
// Implements interface Committer
func (rs *Store) GetPruning() pruningtypes.PruningOptions {
return pruningtypes.NewPruningOptions(pruningtypes.PruningDefault)
}
// Implements interface Store
func (rs *Store) GetStoreType() types.StoreType {
return types.StoreTypeMulti
}
// Implements interface CacheWrapper
func (rs *Store) CacheWrap() types.CacheWrap {
return rs.CacheMultiStore().(types.CacheWrap)
}
// Implements interface CacheWrapper
func (rs *Store) CacheWrapWithTrace(_ io.Writer, _ types.TraceContext) types.CacheWrap {
return rs.CacheWrap()
}
// Implements interface MultiStore
func (rs *Store) CacheMultiStore() types.CacheMultiStore {
stores := make(map[types.StoreKey]types.CacheWrapper)
for k, v := range rs.stores {
store := types.KVStore(v)
// Wire the listenkv.Store to allow listeners to observe the writes from the cache store,
// set same listeners on cache store will observe duplicated writes.
if rs.ListeningEnabled(k) {
store = listenkv.NewStore(store, k, rs.listeners[k])
}
stores[k] = store
}
return cachemulti.NewStore(nil, stores, rs.keysByName, nil, nil)
}
// Implements interface MultiStore
// used to createQueryContext, abci_query or grpc query service.
func (rs *Store) CacheMultiStoreWithVersion(version int64) (types.CacheMultiStore, error) {
if version == 0 || (rs.lastCommitInfo != nil && version == rs.lastCommitInfo.Version) {
return rs.CacheMultiStore(), nil
}
opts := rs.opts
opts.TargetVersion = uint32(version)
opts.ReadOnly = true
db, err := memiavl.Load(rs.dir, opts)
if err != nil {
return nil, err
}
stores := make(map[types.StoreKey]types.CacheWrapper)
// add the transient/mem stores registered in current app.
for k, store := range rs.stores {
if store.GetStoreType() != types.StoreTypeIAVL {
stores[k] = store
}
}
// add all the iavl stores at the target version.
for _, tree := range db.Trees() {
stores[rs.keysByName[tree.Name]] = memiavlstore.New(tree.Tree, rs.logger)
}
return cachemulti.NewStore(nil, stores, rs.keysByName, nil, nil), nil
}
// Implements interface MultiStore
func (rs *Store) GetStore(key types.StoreKey) types.Store {
return rs.stores[key]
}
// Implements interface MultiStore
func (rs *Store) GetKVStore(key types.StoreKey) types.KVStore {
return rs.stores[key]
}
// Implements interface MultiStore
func (rs *Store) TracingEnabled() bool {
return false
}
// Implements interface MultiStore
func (rs *Store) SetTracer(w io.Writer) types.MultiStore {
return nil
}
// Implements interface MultiStore
func (rs *Store) SetTracingContext(types.TraceContext) types.MultiStore {
return nil
}
// Implements interface MultiStore
func (rs *Store) LatestVersion() int64 {
return rs.db.Version()
}
// Implements interface Snapshotter
func (rs *Store) Snapshot(height uint64, protoWriter protoio.Writer) error {
return rs.db.Snapshot(height, protoWriter)
}
// Implements interface Snapshotter
func (rs *Store) Restore(height uint64, format uint32, protoReader protoio.Reader) (snapshottypes.SnapshotItem, error) {
if rs.db != nil {
if err := rs.db.Close(); err != nil {
return snapshottypes.SnapshotItem{}, fmt.Errorf("failed to close db: %w", err)
}
rs.db = nil
}
item, err := memiavl.Import(rs.dir, height, format, protoReader)
if err != nil {
return item, err
}
return item, rs.LoadLatestVersion()
}
// Implements interface Snapshotter
// not needed, memiavl manage its own snapshot/pruning strategy
func (rs *Store) PruneSnapshotHeight(height int64) {
}
// Implements interface Snapshotter
// not needed, memiavl manage its own snapshot/pruning strategy
func (rs *Store) SetSnapshotInterval(snapshotInterval uint64) {
}
// Implements interface CommitMultiStore
func (rs *Store) MountStoreWithDB(key types.StoreKey, typ types.StoreType, _ dbm.DB) {
if key == nil {
panic("MountIAVLStore() key cannot be nil")
}
if _, ok := rs.storesParams[key]; ok {
panic(fmt.Sprintf("store duplicate store key %v", key))
}
if _, ok := rs.keysByName[key.Name()]; ok {
panic(fmt.Sprintf("store duplicate store key name %v", key))
}
rs.storesParams[key] = newStoreParams(key, typ)
rs.keysByName[key.Name()] = key
}
// Implements interface CommitMultiStore
func (rs *Store) GetCommitStore(key types.StoreKey) types.CommitStore {
return rs.GetCommitKVStore(key)
}
// Implements interface CommitMultiStore
func (rs *Store) GetCommitKVStore(key types.StoreKey) types.CommitKVStore {
return rs.stores[key]
}
// Implements interface CommitMultiStore
// used by normal node startup.
func (rs *Store) LoadLatestVersion() error {
return rs.LoadVersionAndUpgrade(0, nil)
}
// Implements interface CommitMultiStore
func (rs *Store) LoadLatestVersionAndUpgrade(upgrades *types.StoreUpgrades) error {
return rs.LoadVersionAndUpgrade(0, upgrades)
}
// Implements interface CommitMultiStore
// used by node startup with UpgradeStoreLoader
func (rs *Store) LoadVersionAndUpgrade(version int64, upgrades *types.StoreUpgrades) error {
if version > math.MaxUint32 {
return fmt.Errorf("version overflows uint32: %d", version)
}
storesKeys := make([]types.StoreKey, 0, len(rs.storesParams))
for key := range rs.storesParams {
storesKeys = append(storesKeys, key)
}
// deterministic iteration order for upgrades
sort.Slice(storesKeys, func(i, j int) bool {
return storesKeys[i].Name() < storesKeys[j].Name()
})
initialStores := make([]string, 0, len(storesKeys))
for _, key := range storesKeys {
if rs.storesParams[key].typ == types.StoreTypeIAVL {
initialStores = append(initialStores, key.Name())
}
}
opts := rs.opts
opts.CreateIfMissing = true
opts.InitialStores = initialStores
opts.TargetVersion = uint32(version)
db, err := memiavl.Load(rs.dir, opts)
if err != nil {
return errors.Wrapf(err, "fail to load memiavl at %s", rs.dir)
}
var treeUpgrades []*memiavl.TreeNameUpgrade
for _, key := range storesKeys {
switch {
case upgrades.IsDeleted(key.Name()):
treeUpgrades = append(treeUpgrades, &memiavl.TreeNameUpgrade{Name: key.Name(), Delete: true})
case upgrades.IsAdded(key.Name()) || upgrades.RenamedFrom(key.Name()) != "":
treeUpgrades = append(treeUpgrades, &memiavl.TreeNameUpgrade{Name: key.Name(), RenameFrom: upgrades.RenamedFrom(key.Name())})
}
}
if len(treeUpgrades) > 0 {
if err := db.ApplyUpgrades(treeUpgrades); err != nil {
return err
}
}
newStores := make(map[types.StoreKey]types.CommitKVStore, len(storesKeys))
for _, key := range storesKeys {
newStores[key], err = rs.loadCommitStoreFromParams(db, key, rs.storesParams[key])
if err != nil {
return err
}
}
rs.db = db
rs.stores = newStores
// to keep the root hash compatible with cosmos-sdk 0.46
if db.Version() != 0 {
rs.lastCommitInfo = db.LastCommitInfo()
if rs.sdk46Compact {
rs.lastCommitInfo = amendCommitInfo(rs.lastCommitInfo, rs.storesParams)
}
} else {
rs.lastCommitInfo = &types.CommitInfo{}
}
return nil
}
func (rs *Store) loadCommitStoreFromParams(db *memiavl.DB, key types.StoreKey, params storeParams) (types.CommitKVStore, error) {
switch params.typ {
case types.StoreTypeMulti:
panic("recursive MultiStores not yet supported")
case types.StoreTypeIAVL:
tree := db.TreeByName(key.Name())
if tree == nil {
return nil, fmt.Errorf("new store is not added in upgrades: %s", key.Name())
}
return types.CommitKVStore(memiavlstore.New(tree, rs.logger)), nil
case types.StoreTypeDB:
panic("recursive MultiStores not yet supported")
case types.StoreTypeTransient:
_, ok := key.(*types.TransientStoreKey)
if !ok {
return nil, fmt.Errorf("invalid StoreKey for StoreTypeTransient: %s", key.String())
}
return transient.NewStore(), nil
case types.StoreTypeMemory:
if _, ok := key.(*types.MemoryStoreKey); !ok {
return nil, fmt.Errorf("unexpected key type for a MemoryStoreKey; got: %s", key.String())
}
return mem.NewStore(), nil
default:
panic(fmt.Sprintf("unrecognized store type %v", params.typ))
}
}
// Implements interface CommitMultiStore
// used by export cmd
func (rs *Store) LoadVersion(ver int64) error {
return rs.LoadVersionAndUpgrade(ver, nil)
}
// SetInterBlockCache is a noop here because memiavl do caching on it's own, which works well with zero-copy.
func (rs *Store) SetInterBlockCache(c types.MultiStorePersistentCache) {}
// Implements interface CommitMultiStore
// used by InitChain when the initial height is bigger than 1
func (rs *Store) SetInitialVersion(version int64) error {
return rs.db.SetInitialVersion(version)
}
// Implements interface CommitMultiStore
func (rs *Store) SetIAVLCacheSize(size int) {
}
// Implements interface CommitMultiStore
func (rs *Store) SetIAVLDisableFastNode(disable bool) {
}
// Implements interface CommitMultiStore
func (rs *Store) SetLazyLoading(lazyLoading bool) {
}
func (rs *Store) SetMemIAVLOptions(opts memiavl.Options) {
if opts.Logger == nil {
opts.Logger = rs.logger.With("module", "memiavl")
}
rs.opts = opts
}
// RollbackToVersion delete the versions after `target` and update the latest version.
// it should only be called in standalone cli commands.
func (rs *Store) RollbackToVersion(target int64) error {
if target <= 0 {
return fmt.Errorf("invalid rollback height target: %d", target)
}
if target > math.MaxUint32 {
return fmt.Errorf("rollback height target %d exceeds max uint32", target)
}
if rs.db != nil {
if err := rs.db.Close(); err != nil {
return err
}
}
opts := rs.opts
opts.TargetVersion = uint32(target)
opts.LoadForOverwriting = true
var err error
rs.db, err = memiavl.Load(rs.dir, opts)
return err
}
// Implements interface CommitMultiStore
func (rs *Store) ListeningEnabled(key types.StoreKey) bool {
if ls, ok := rs.listeners[key]; ok {
return len(ls) != 0
}
return false
}
// Implements interface CommitMultiStore
func (rs *Store) AddListeners(key types.StoreKey, listeners []types.WriteListener) {
if ls, ok := rs.listeners[key]; ok {
rs.listeners[key] = append(ls, listeners...)
} else {
rs.listeners[key] = listeners
}
}
// getStoreByName performs a lookup of a StoreKey given a store name typically
// provided in a path. The StoreKey is then used to perform a lookup and return
// a Store. If the Store is wrapped in an inter-block cache, it will be unwrapped
// prior to being returned. If the StoreKey does not exist, nil is returned.
func (rs *Store) GetStoreByName(name string) types.Store {
key := rs.keysByName[name]
if key == nil {
return nil
}
return rs.GetCommitKVStore(key)
}
// Implements interface Queryable
func (rs *Store) Query(req abci.RequestQuery) abci.ResponseQuery {
version := req.Height
if version == 0 {
version = rs.db.Version()
}
// If the request's height is the latest height we've committed, then utilize
// the store's lastCommitInfo as this commit info may not be flushed to disk.
// Otherwise, we query for the commit info from disk.
db := rs.db
if version != rs.lastCommitInfo.Version {
var err error
db, err = memiavl.Load(rs.dir, memiavl.Options{TargetVersion: uint32(version), ReadOnly: true})
if err != nil {
return sdkerrors.QueryResult(err, false)
}
defer db.Close()
}
path := req.Path
storeName, subpath, err := parsePath(path)
if err != nil {
return sdkerrors.QueryResult(err, false)
}
store := types.Queryable(memiavlstore.New(db.TreeByName(storeName), rs.logger))
// trim the path and make the query
req.Path = subpath
res := store.Query(req)
if !req.Prove || !rootmulti.RequireProof(subpath) {
return res
}
if res.ProofOps == nil || len(res.ProofOps.Ops) == 0 {
return sdkerrors.QueryResult(errors.Wrap(sdkerrors.ErrInvalidRequest, "proof is unexpectedly empty; ensure height has not been pruned"), false)
}
commitInfo := db.LastCommitInfo()
if rs.sdk46Compact {
commitInfo = amendCommitInfo(commitInfo, rs.storesParams)
}
// Restore origin path and append proof op.
res.ProofOps.Ops = append(res.ProofOps.Ops, commitInfo.ProofOp(storeName))
return res
}
// parsePath expects a format like /<storeName>[/<subpath>]
// Must start with /, subpath may be empty
// Returns error if it doesn't start with /
func parsePath(path string) (storeName string, subpath string, err error) {
if !strings.HasPrefix(path, "/") {
return storeName, subpath, errors.Wrapf(sdkerrors.ErrUnknownRequest, "invalid path: %s", path)
}
paths := strings.SplitN(path[1:], "/", 2)
storeName = paths[0]
if len(paths) == 2 {
subpath = "/" + paths[1]
}
return storeName, subpath, nil
}
type storeParams struct {
key types.StoreKey
typ types.StoreType
}
func newStoreParams(key types.StoreKey, typ types.StoreType) storeParams {
return storeParams{
key: key,
typ: typ,
}
}
func mergeStoreInfos(commitInfo *types.CommitInfo, storeInfos []types.StoreInfo) *types.CommitInfo {
infos := make([]types.StoreInfo, 0, len(commitInfo.StoreInfos)+len(storeInfos))
infos = append(infos, commitInfo.StoreInfos...)
infos = append(infos, storeInfos...)
sort.SliceStable(infos, func(i, j int) bool {
return infos[i].Name < infos[j].Name
})
return &types.CommitInfo{
Version: commitInfo.Version,
StoreInfos: infos,
}
}
// amendCommitInfo add mem stores commit infos to keep it compatible with cosmos-sdk 0.46
func amendCommitInfo(commitInfo *types.CommitInfo, storeParams map[types.StoreKey]storeParams) *types.CommitInfo {
var extraStoreInfos []types.StoreInfo
for key := range storeParams {
typ := storeParams[key].typ
if typ != types.StoreTypeIAVL && typ != types.StoreTypeTransient {
extraStoreInfos = append(extraStoreInfos, types.StoreInfo{
Name: key.Name(),
CommitId: types.CommitID{},
})
}
}
return mergeStoreInfos(commitInfo, extraStoreInfos)
}