Fast Cache - Downgrade - reupgrade protection and other improvements #12
Conversation
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 was
linked to
issues
Jan 26, 2022
|
It seems that GetwithIndex and GetByIndex have actually become worse off: Using fast node iterations to GetWithIndex and GetByIndex might not be the most optimal solution. It does make sense because traversing the tree allows searching for the correct key in O(log(n)) whereas iterations in O(n). The fact that O(n) fast iteration preserves data locality does not help to outperform O(log(n)) tree search with no data locality I reverted the changes for The non-membership proof is still better off, however. Even as I was increasing the key size, the difference between old and new implementations was growing. |
5 tasks
p0mvn
changed the title
|
@ValarDragon Please review. This branch is diffed against my older PR #5. It also needs some more 👀 |
ValarDragon
reviewed
Jan 30, 2022
| @@ -760,10 +761,8 @@ func (tree *MutableTree) saveFastNodeVersion() error { | |||
| return err | |||
| } | |||
|
|
|||
| if !tree.ndb.isFastStorageEnabled() { | |||
There was a problem hiding this comment.
This is removed because its only called if tree.ndb.isFastStorageEnabled is true?
If so, can we add a comment stating this above the saveFastNodeVersion function?
There was a problem hiding this comment.
The reason why this was removed is that now we are going with the assumption that fast cache storage will be upgraded to on all versions above 1.1.0 or fastStorageVersionValue. Therefore, we must make sure that we persist the latest live version on disk. Otherwise, re-upgrade protection would not function correctly.
In case there is any confusion, there are now 2 separate methods that check for fast storage to be enabled:
- in nodeDB (
hasUpgradedToFastStorage)- This method checks that the upgrade has happened. When the upgrade is successful, fast storage on disk must match the latest tree.
- I renamed this method from
isFastStorageEnabledtohasUpgradedToFastStorageand added a comment for clarity
- in immutable tree (
isFastStorageEnabled)- This one checks for 2 conditions:
- The tree is of the latest version
- hasUpgradedToFastStorage - this one is more of a sanity check since now we are assuming that the upgrade should persist forever unless manually downgraded.
- also added a comment
- This one checks for 2 conditions:
Let me know if this makes sense
ValarDragon
reviewed
Jan 30, 2022
| var nextKey []byte = nil | ||
|
|
||
| done := false | ||
| itr := t.Iterator(nil, nil, true) |
There was a problem hiding this comment.
Hrmm, isn't iterating over all of fast node state going to be slower than a logarithmic number of file opens? Is there a way we can set a 'smarter' start bound?
There was a problem hiding this comment.
I think we can do this speedup in a non-db breaking way later, so may also be worth commenting out its invocation in GetNonMembershipProof and revisiting after we get the initial release out!
ValarDragon
reviewed
Jan 30, 2022
ValarDragon
reviewed
Jan 30, 2022
| return true | ||
| } | ||
| } | ||
| return false |
There was a problem hiding this comment.
This should never happen under correct behavior right? Should we add a comment do a fmt.Println if this occurs?
There was a problem hiding this comment.
This should happen when we have already upgraded to fast storage and it matches the latest state to avoid redundantly upgrading fast nodes when they are already live
There was a problem hiding this comment.
This should also happen if we are on the default (non-fast) storage version. This method is independent from hasUpgradedToFastStorage.
To avoid confusion,
hasUpgradedToFastStorage - returns true if we have upgraded to fast storage, false if we are on default
shouldForceFastStorageUpdate - returns true if we have upgraded to fast storage but it does not match the live state, false otherwise
ValarDragon
reviewed
Jan 30, 2022
ValarDragon
reviewed
Jan 30, 2022
nodedb.go
Outdated
| @@ -211,6 +219,10 @@ func (ndb *nodeDB) SaveFastNode(node *FastNode) error { | |||
| } | |||
|
|
|||
| func (ndb *nodeDB) setStorageVersion(newVersion string) error { | |||
| if newVersion >= fastStorageVersionValue { | |||
| newVersion = newVersion + fastStorageVersionDelimiter + strconv.Itoa(int(ndb.latestVersion)) | |||
There was a problem hiding this comment.
won't we be infinitely appending to newVersion like this, if newVersion gets parsed from the serialized value later?
There was a problem hiding this comment.
I don't think any of the tests test repeated calls of parsing & setting but maybe i'm wrong
There was a problem hiding this comment.
You are right, good catch.
I refactored this method completely and renamed it to setFastStorageVersionToBatch. Now, it does not take version as a parameter. Parses the storageVersion and updates it to fast, if needed, with the latest live tree version. Added more unit tests to make sure all code branches are covered
…edToFastStorage and shouldForceFastStorageUpdate
|
@ValarDragon addressed all comments so far. The most recent updates:
Please take a look when you have time |
|
Changes LGTM!! |
ValarDragon
approved these changes
Feb 7, 2022
p0mvn
added a commit
that referenced
this pull request
Feb 11, 2022
…12) * add leaf hash to fast node and unit test * refactor get with index and get by index, fix migration in load version and lazy load version * use Get in GetVersioned of mutable tree * refactor non membership proof to use fast storage if available * bench non-membership proof * fix bench tests to work with the new changes * add downgrade-reupgrade protection and unit test * remove leaf hash from fast node * resolve multithreading bug related to iterators not being closed * clean up * use correct tree in bench tests * add cache to tree used to bench non membership proofs * add benc tests for GetWithIndex and GetByIndex * revert GetWithIndex and GetByIndex * remove unused import * unit test re-upgrade protection and fix small issues * remove redundant setStorageVersion method * fix bug with appending to live stage version to storage version and nit test * add comment for setFastStorageVersionToBatch * refactor and improve unit tests for reupgrade protection * rename ndb's isFastStorageEnabled to hasUpgradedToFastStorage and add comments * comment out new implementation for GetNonMembershipProof * update comments in nodedb to reflect the difference between hasUpgradedToFastStorage and shouldForceFastStorageUpdate * refactor nodedb tests * downgrade tendermint to 0.34.14 - osmosis's latest cosmos sdk does not support 0.35.0 * fix bug where fast storage was not enabled when version 0 was attempted to be loaded * implement unsaved fast iterator to be used in mutable tree (#16)
p0mvn
added a commit
that referenced
this pull request
Feb 11, 2022
…12) * add leaf hash to fast node and unit test * refactor get with index and get by index, fix migration in load version and lazy load version * use Get in GetVersioned of mutable tree * refactor non membership proof to use fast storage if available * bench non-membership proof * fix bench tests to work with the new changes * add downgrade-reupgrade protection and unit test * remove leaf hash from fast node * resolve multithreading bug related to iterators not being closed * clean up * use correct tree in bench tests * add cache to tree used to bench non membership proofs * add benc tests for GetWithIndex and GetByIndex * revert GetWithIndex and GetByIndex * remove unused import * unit test re-upgrade protection and fix small issues * remove redundant setStorageVersion method * fix bug with appending to live stage version to storage version and nit test * add comment for setFastStorageVersionToBatch * refactor and improve unit tests for reupgrade protection * rename ndb's isFastStorageEnabled to hasUpgradedToFastStorage and add comments * comment out new implementation for GetNonMembershipProof * update comments in nodedb to reflect the difference between hasUpgradedToFastStorage and shouldForceFastStorageUpdate * refactor nodedb tests * downgrade tendermint to 0.34.14 - osmosis's latest cosmos sdk does not support 0.35.0 * fix bug where fast storage was not enabled when version 0 was attempted to be loaded * implement unsaved fast iterator to be used in mutable tree (#16)
p0mvn
added a commit
that referenced
this pull request
Feb 11, 2022
…12) * add leaf hash to fast node and unit test * refactor get with index and get by index, fix migration in load version and lazy load version * use Get in GetVersioned of mutable tree * refactor non membership proof to use fast storage if available * bench non-membership proof * fix bench tests to work with the new changes * add downgrade-reupgrade protection and unit test * remove leaf hash from fast node * resolve multithreading bug related to iterators not being closed * clean up * use correct tree in bench tests * add cache to tree used to bench non membership proofs * add benc tests for GetWithIndex and GetByIndex * revert GetWithIndex and GetByIndex * remove unused import * unit test re-upgrade protection and fix small issues * remove redundant setStorageVersion method * fix bug with appending to live stage version to storage version and nit test * add comment for setFastStorageVersionToBatch * refactor and improve unit tests for reupgrade protection * rename ndb's isFastStorageEnabled to hasUpgradedToFastStorage and add comments * comment out new implementation for GetNonMembershipProof * update comments in nodedb to reflect the difference between hasUpgradedToFastStorage and shouldForceFastStorageUpdate * refactor nodedb tests * downgrade tendermint to 0.34.14 - osmosis's latest cosmos sdk does not support 0.35.0 * fix bug where fast storage was not enabled when version 0 was attempted to be loaded * implement unsaved fast iterator to be used in mutable tree (#16)
p0mvn
added a commit
that referenced
this pull request
Feb 13, 2022
…12) * add leaf hash to fast node and unit test * refactor get with index and get by index, fix migration in load version and lazy load version * use Get in GetVersioned of mutable tree * refactor non membership proof to use fast storage if available * bench non-membership proof * fix bench tests to work with the new changes * add downgrade-reupgrade protection and unit test * remove leaf hash from fast node * resolve multithreading bug related to iterators not being closed * clean up * use correct tree in bench tests * add cache to tree used to bench non membership proofs * add benc tests for GetWithIndex and GetByIndex * revert GetWithIndex and GetByIndex * remove unused import * unit test re-upgrade protection and fix small issues * remove redundant setStorageVersion method * fix bug with appending to live stage version to storage version and nit test * add comment for setFastStorageVersionToBatch * refactor and improve unit tests for reupgrade protection * rename ndb's isFastStorageEnabled to hasUpgradedToFastStorage and add comments * comment out new implementation for GetNonMembershipProof * update comments in nodedb to reflect the difference between hasUpgradedToFastStorage and shouldForceFastStorageUpdate * refactor nodedb tests * downgrade tendermint to 0.34.14 - osmosis's latest cosmos sdk does not support 0.35.0 * fix bug where fast storage was not enabled when version 0 was attempted to be loaded * implement unsaved fast iterator to be used in mutable tree (#16)
faddat
pushed a commit
to faddat/iavl
that referenced
this pull request
Apr 11, 2022
* Add unbounded key string to KeyFormat * Add test vectors for unbounded length keys * Add some notes * update .gitignore * Add FastNode struct * WIP: make Get work with new FastNode * when retrieving fastnode fails, return errors vs. panic * add comments clarifying what index represents * make the linter happy * Add small tweaks to fast_node.go * add TODO & small linter tweaks * Update comment * update fast node cache in set * add debugging output when falling back to original logic * return error instead of panic * WIP: refactor set ops to work with fast store * update Set of mutable tree, begin unit testing * update GetVersioned to check fast nodes before trying the immutable * check fast node version before nil value check in get of immutable tree * fix small bugs and typos, continue writing unit tests for Set * unit test saveFastNodeVersion * simplify storing unsaved fast nodes * resolve a bug with not writing prefix for fast node to disk * remove fast nodes from disk on save and clear fast cache when version is deleted, fix all tests but random and with index * resolve an issue with randomized tests caused by the fast node cache not being cleared when latest version is saved * split unsaved fast node changes into additions and removals * save fast node removals * move fast node cache clearing to nodedb * use regular logic only when fast node version is greater than immutable tree' * clean up tree_random_test.go * clear unsaved fast node removals on rollback * fix randomized test failures caused by a typo in ndb DeleteVersion for loop * implement GetFast method to preserve Get with correct index return, convert unit tests from Get to GetFast where applicable * ensure Get and GetFast return the same values in tree_random_test.go * test fast node cache is live in random tree tests * improve mutable tree unit tests related to new functionality * clean up tree_test.go * implement GetVersionedFast to preserve the index in GetVersioned * restore accidentally deleted test in mutable tree test * spurious whitespace * refactor mutable tree * fix comment in mutable tree * add benchmark results * avoid redundant full tree search in GetFast of immutable tree when fast node is nil and tree is latest * fix naming for bench test get on random keys * use method for get latestversio in get fast * optimize GetFast, perform a refactor to ensure that fast nodes on disk are matched and better test * add latest bench * Fast Node Iteration (osmosis-labs#7) * propagate errors from nodedb and avoid panicking * begin implementing fast node iteration * resolve rebase issue in random tests * fix iteration to deserialize fast node for extracting the correct value * finalzie iteration and let all unit tests pass * add benchmarks * merge GetVersioned and GetVersionedFast * remove fast node deletion from DeleteVersion and DeleteVersionRange and benchmark * fix and unit test iteration on mutable and immutable trees * implement tests for iterator and iterate, begin testing fast iterator * fix and unit test fast iterator * refactor iterate methods of mutable and immutable trees * resolve some warnings * remove old bench results * refactor bench tests for iteration * Fast Cache Migration (osmosis-labs#9) * implement nodedb changes to set and get chain version from the database * implement and unit test upgrade to fast storage in mutable tree * refactor for auto upgrade to fast version in mutable tree contructor, load version and lazy load version * use proper functionality for getting latest version * remove unused error * fix comment * use fast version value in tests * spurious tab * fix style problems and remove redundant code in tests * Rename Get to GetWithIndex and GetFast to Get * refactor and clean up bench tests * remove extra byte from fast node length * clean up immutable tree * refactor nil tree or ndb error for the iterators and their tests * avoid exporting methods for getting unsaved additions and removals * refactor fast upgrade to read from tree instead of traversing disk nodes and orphans, update unit tests * remove unneeded comment * refer to storage version consistently across the project * fix more warnings * optimize removal of fast nodes from cache on deletion * small changes in teh mutable tree * correct storage version key * auto set fast version in SaveVersion * avoid exporting new methods of the immutable tree * go fmt * Fix comment in fast iterator Co-authored-by: Dev Ojha <[email protected]> * add extra comment for domain in fast iterator Co-authored-by: Dev Ojha <[email protected]> * add comments for moving the iterator before the first element * add comment for describing what mirror is in assertIterator of testutils * fix checking the mirror for descending iterator in tests * Update testutils_test.go with a comment Co-authored-by: Dev Ojha <[email protected]> * Update benchmarks/bench_test.go with a comment for runKnownQueriesFast Co-authored-by: Dev Ojha <[email protected]> * Update benchmarks/bench_test.go with a comment for runQueriesFast Co-authored-by: Dev Ojha <[email protected]> * export IsFastCacheEnabled and add an assert in bench tests * Update comment immutable_tree.go Co-authored-by: Dev Ojha <[email protected]> * Update comment for migration in mutable_tree.go Co-authored-by: Dev Ojha <[email protected]> * simlify Iterate in mutable tree, add debug log for * Fast Cache - Downgrade - reupgrade protection and other improvements (osmosis-labs#12) * add leaf hash to fast node and unit test * refactor get with index and get by index, fix migration in load version and lazy load version * use Get in GetVersioned of mutable tree * refactor non membership proof to use fast storage if available * bench non-membership proof * fix bench tests to work with the new changes * add downgrade-reupgrade protection and unit test * remove leaf hash from fast node * resolve multithreading bug related to iterators not being closed * clean up * use correct tree in bench tests * add cache to tree used to bench non membership proofs * add benc tests for GetWithIndex and GetByIndex * revert GetWithIndex and GetByIndex * remove unused import * unit test re-upgrade protection and fix small issues * remove redundant setStorageVersion method * fix bug with appending to live stage version to storage version and nit test * add comment for setFastStorageVersionToBatch * refactor and improve unit tests for reupgrade protection * rename ndb's isFastStorageEnabled to hasUpgradedToFastStorage and add comments * comment out new implementation for GetNonMembershipProof * update comments in nodedb to reflect the difference between hasUpgradedToFastStorage and shouldForceFastStorageUpdate * refactor nodedb tests * downgrade tendermint to 0.34.14 - osmosis's latest cosmos sdk does not support 0.35.0 * fix bug where fast storage was not enabled when version 0 was attempted to be loaded * implement unsaved fast iterator to be used in mutable tree (osmosis-labs#16) * address comments from unsaved fast iterator PR * expose isUpgradeable method on mutable tree and unit test (osmosis-labs#17) * expose isUpgradeable method on mutable tree and unit test * go fmt * resolve problems with rebasing * update CHANGELOG.md * tendermint v0.35.0 * fix String() bench * fix duplication lint in iterator_test.go * fix lint for tree.ndb.DeleteFastNode error return not checked * fix Error return value of `ndb.resetBatch` is not checked * fix Error return value of `ndb.traversePrefix` is not checked * fix Error: struct of size 64 bytes could be of size 56 bytes * fix Error: `comitted` is a misspelling of `committed` * fix issues in basic_test.go * address comments in fast_iterator.go * address comments in immutable tree * address comments in iterator.go * address comments in key_format.go * address remaining comments * fix Error: Error return value of `ndb.batch.Write` is not checked * fix Error: receiver name t should be consistent with previous receiver name tree for MutableTree * fix Error: struct of size 48 bytes could be of size 40 bytes * go fmt * more linter fixes * fix remaining linter problems * upgrade tm-db and comment out broken bencher databases * skip iterations for BenchmarkLevelDBLargeData bench * attempt to fix linter * force GC, no cache during migration, auto heap profile (osmosis-labs#19) * force GC, no cache during migration, auto heap profile * resolve a potential deadlock from racing between reset and stop * fix small lint issue * remove logs and pprof logic * remove unused libraries * add comment explaining the reason for RAM optimizations * sync access to fast node cache to avoid concurrent write fatal error (osmosis-labs#23) * update go.mod and go.sum to match master versions * revert osmosis-labs#23 (sync access to fast node cache), fix bug related to old height export (osmosis-labs#33) * Revert "sync access to fast node cache to avoid concurrent write fatal error (osmosis-labs#23)" This reverts commit 2a1daf4. * return correct iterator in mutable tree * fix concurrent map panic when querying and comittting concurrently * avoid clearing fast node cache during pruning (osmosis-labs#35) * fix data race related to VersionExists (osmosis-labs#36) * fix data race related to VersionExists * use regular lock instead of RW in mutable_tree.go * hardcode fast node cache size to 100k * go fmt * restore proof_ics23.go * fix linter Co-authored-by: ValarDragon <[email protected]> Co-authored-by: jtieri <[email protected]> Co-authored-by: Dev Ojha <[email protected]> Co-authored-by: Roman Akhtariev <[email protected]> Co-authored-by: Roman <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
#11 - Background
We would like to add downgrade and re-upgrade protection for the fast cache. Write the last fast node version on each block and check it at the startup. If not set to the most recent version, rewrite fast cache
Acceptance criteria
Additionally:
LoadVersionandLazyLoadVersionGetWithIdndexandGetByIndexGetWithIndex,GetByIndexand `Latest benchmark for non-membership proof:
Old benchmark from
dev/iavl_data_localitywith modified bench tests:Latest benchmark: