R4R: Store Refactor 1 #2985
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| package cachekv | ||
|
|
||
| import ( | ||
| "bytes" | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| package cachekv | ||
|
|
||
| import ( | ||
| "bytes" | ||
|
|
@@ -8,6 +8,10 @@ import ( | |
|
|
||
| cmn "github.com/tendermint/tendermint/libs/common" | ||
| dbm "github.com/tendermint/tendermint/libs/db" | ||
|
|
||
| "github.com/cosmos/cosmos-sdk/store/types" | ||
|
|
||
| "github.com/cosmos/cosmos-sdk/store/tracekv" | ||
| ) | ||
|
|
||
| // If value is nil but deleted is false, it means the parent doesn't have the | ||
|
|
@@ -18,30 +22,30 @@ type cValue struct { | |
| dirty bool | ||
| } | ||
|
|
||
| // Store wraps an in-memory cache around an underlying types.KVStore. | ||
| type Store struct { | ||
| mtx sync.Mutex | ||
| cache map[string]cValue | ||
| parent types.KVStore | ||
| } | ||
|
|
||
| var _ types.CacheKVStore = (*Store)(nil) | ||
|
|
||
| // nolint | ||
| func NewStore(parent types.KVStore) *Store { | ||
| return &Store{ | ||
| cache: make(map[string]cValue), | ||
| parent: parent, | ||
| } | ||
| } | ||
|
|
||
| // Implements Store. | ||
| func (ci *Store) GetStoreType() types.StoreType { | ||
mossid marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return ci.parent.GetStoreType() | ||
| } | ||
|
|
||
| // Implements types.KVStore. | ||
| func (ci *Store) Get(key []byte) (value []byte) { | ||
| ci.mtx.Lock() | ||
| defer ci.mtx.Unlock() | ||
| ci.assertValidKey(key) | ||
|
|
@@ -57,8 +61,8 @@ func (ci *cacheKVStore) Get(key []byte) (value []byte) { | |
| return value | ||
| } | ||
|
|
||
| // Implements types.KVStore. | ||
| func (ci *Store) Set(key []byte, value []byte) { | ||
| ci.mtx.Lock() | ||
| defer ci.mtx.Unlock() | ||
| ci.assertValidKey(key) | ||
|
|
@@ -67,33 +71,23 @@ func (ci *cacheKVStore) Set(key []byte, value []byte) { | |
| ci.setCacheValue(key, value, false, true) | ||
| } | ||
|
|
||
| // Implements types.KVStore. | ||
| func (ci *Store) Has(key []byte) bool { | ||
| value := ci.Get(key) | ||
| return value != nil | ||
| } | ||
|
|
||
| // Implements types.KVStore. | ||
| func (ci *Store) Delete(key []byte) { | ||
| ci.mtx.Lock() | ||
| defer ci.mtx.Unlock() | ||
| ci.assertValidKey(key) | ||
|
|
||
| ci.setCacheValue(key, nil, true, true) | ||
| } | ||
|
|
||
| // Implements Cachetypes.KVStore. | ||
| func (ci *Store) Write() { | ||
| ci.mtx.Lock() | ||
| defer ci.mtx.Unlock() | ||
|
|
||
|
|
@@ -126,33 +120,33 @@ func (ci *cacheKVStore) Write() { | |
| } | ||
|
|
||
| //---------------------------------------- | ||
| // To cache-wrap this Store further. | ||
|
|
||
| // Implements CacheWrapper. | ||
| func (ci *Store) CacheWrap() types.CacheWrap { | ||
|
There was a problem hiding this comment. Does it make sense to cache-wrap an already cached store? I recall there are places where we do this, but it leads to difficult debugging. There was a problem hiding this comment. I think we will need multiple layers of cache wrapping in some cases(one of the examples is https://github.com/cosmos/cosmos-sdk/blob/develop/types/context.go#L235), although I'm not advocating it hard. There was a problem hiding this comment. I think it's OK, but SDK applications should be careful about repeatedly cache-wrapping. |
||
| return NewStore(ci) | ||
| } | ||
|
|
||
| // CacheWrapWithTrace implements the CacheWrapper interface. | ||
| func (ci *Store) CacheWrapWithTrace(w io.Writer, tc types.TraceContext) types.CacheWrap { | ||
|
|
||
| return NewStore(tracekv.NewStore(ci, w, tc)) | ||
| } | ||
|
|
||
| //---------------------------------------- | ||
| // Iteration | ||
|
|
||
| // Implements types.KVStore. | ||
| func (ci *Store) Iterator(start, end []byte) types.Iterator { | ||
| return ci.iterator(start, end, true) | ||
| } | ||
|
|
||
| // Implements types.KVStore. | ||
| func (ci *Store) ReverseIterator(start, end []byte) types.Iterator { | ||
| return ci.iterator(start, end, false) | ||
| } | ||
|
|
||
| func (ci *Store) iterator(start, end []byte, ascending bool) types.Iterator { | ||
| var parent, cache types.Iterator | ||
|
|
||
| if ascending { | ||
| parent = ci.parent.Iterator(start, end) | ||
|
|
@@ -167,7 +161,7 @@ func (ci *cacheKVStore) iterator(start, end []byte, ascending bool) Iterator { | |
| } | ||
|
|
||
| // Constructs a slice of dirty items, to use w/ memIterator. | ||
| func (ci *Store) dirtyItems(start, end []byte, ascending bool) []cmn.KVPair { | ||
| items := make([]cmn.KVPair, 0) | ||
|
|
||
| for key, cacheValue := range ci.cache { | ||
|
|
@@ -192,20 +186,20 @@ func (ci *cacheKVStore) dirtyItems(start, end []byte, ascending bool) []cmn.KVPa | |
| //---------------------------------------- | ||
| // etc | ||
|
|
||
| func (ci *Store) assertValidKey(key []byte) { | ||
| if key == nil { | ||
| panic("key is nil") | ||
| } | ||
| } | ||
|
|
||
| func (ci *Store) assertValidValue(value []byte) { | ||
| if value == nil { | ||
| panic("value is nil") | ||
| } | ||
| } | ||
|
|
||
| // Only entrypoint to mutate ci.cache. | ||
| func (ci *Store) setCacheValue(key, value []byte, deleted bool, dirty bool) { | ||
| ci.cache[string(key)] = cValue{ | ||
| value: value, | ||
| deleted: deleted, | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why we need to set the context to
nilif we set it tosdk.TraceContextthe next line?