feat(lib/trie): Implement limit for trie.ClearPrefix #1905
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,6 +18,7 @@ package trie | |
|
|
||
| import ( | ||
| "bytes" | ||
| "fmt" | ||
|
|
||
| "github.com/ChainSafe/gossamer/lib/common" | ||
| ) | ||
|
|
@@ -509,6 +510,132 @@ func (t *Trie) retrieve(parent node, key []byte) *leaf { | |
| return value | ||
| } | ||
|
|
||
| // ClearPrefixLimit deletes the keys having the prefix till limit reached | ||
| func (t *Trie) ClearPrefixLimit(prefix []byte, limit uint32) (uint32, bool) { | ||
EclesioMeloJunior marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if limit == 0 { | ||
| return 0, false | ||
| } | ||
|
|
||
| p := keyToNibbles(prefix) | ||
| if len(p) > 0 && p[len(p)-1] == 0 { | ||
| p = p[:len(p)-1] | ||
|
There was a problem hiding this comment. question: why we remove the last element if it is equal to There was a problem hiding this comment. We are converting bytes to nibbles and if the last nibble is empty we are removing that. There was a problem hiding this comment. is empty the same as There was a problem hiding this comment. Yes, You can check out this test case gossamer/lib/trie/codec_test.go Line 35 in c5c9c0a |
||
| } | ||
|
|
||
| l := limit | ||
| var allDeleted bool | ||
| t.root, _, allDeleted = t.clearPrefixLimit(t.root, p, &limit) | ||
| return l - limit, allDeleted | ||
| } | ||
|
|
||
| func (t *Trie) clearPrefixLimit(cn node, prefix []byte, limit *uint32) (node, bool, bool) { | ||
EclesioMeloJunior marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| curr := t.maybeUpdateGeneration(cn) | ||
|
|
||
| switch c := curr.(type) { | ||
| case *branch: | ||
| length := lenCommonPrefix(c.key, prefix) | ||
| if length == len(prefix) { | ||
| n, _ := t.deleteNodes(c, []byte{}, limit) | ||
| if n == nil { | ||
| return nil, true, true | ||
| } | ||
| return n, true, false | ||
| } | ||
|
|
||
| if len(prefix) == len(c.key)+1 && length == len(prefix)-1 { | ||
| i := prefix[len(c.key)] | ||
| c.children[i], _ = t.deleteNodes(c.children[i], []byte{}, limit) | ||
|
|
||
| c.setDirty(true) | ||
| curr = handleDeletion(c, prefix) | ||
|
|
||
| if c.children[i] == nil { | ||
| return curr, true, true | ||
| } | ||
| return c, true, false | ||
| } | ||
|
|
||
| if len(prefix) <= len(c.key) || length < len(c.key) { | ||
| // this node doesn't have the prefix, return | ||
| return c, false, true | ||
| } | ||
|
|
||
| i := prefix[len(c.key)] | ||
|
|
||
| var wasUpdated, allDeleted bool | ||
| c.children[i], wasUpdated, allDeleted = t.clearPrefixLimit(c.children[i], prefix[len(c.key)+1:], limit) | ||
| if wasUpdated { | ||
| c.setDirty(true) | ||
| curr = handleDeletion(c, prefix) | ||
| } | ||
|
|
||
| return curr, curr.isDirty(), allDeleted | ||
| case *leaf: | ||
| length := lenCommonPrefix(c.key, prefix) | ||
| if length == len(prefix) { | ||
| *limit-- | ||
| return nil, true, true | ||
| } | ||
| // Prefix not found might be all deleted | ||
| return curr, false, true | ||
|
|
||
| case nil: | ||
| return nil, false, true | ||
| } | ||
|
|
||
| return nil, false, true | ||
| } | ||
|
|
||
| func (t *Trie) deleteNodes(cn node, prefix []byte, limit *uint32) (node, bool) { | ||
| curr := t.maybeUpdateGeneration(cn) | ||
|
|
||
| switch c := curr.(type) { | ||
| case *leaf: | ||
| if *limit == 0 { | ||
| return c, false | ||
| } | ||
| *limit-- | ||
| return nil, true | ||
| case *branch: | ||
| if len(c.key) != 0 { | ||
| prefix = append(prefix, c.key...) | ||
| } | ||
|
|
||
| for i, child := range c.children { | ||
| if child == nil { | ||
| continue | ||
| } | ||
|
|
||
| var isDel bool | ||
| if c.children[i], isDel = t.deleteNodes(child, prefix, limit); !isDel { | ||
| continue | ||
| } | ||
|
|
||
| c.setDirty(true) | ||
| curr = handleDeletion(c, prefix) | ||
| isAllNil := c.numChildren() == 0 | ||
| if isAllNil && c.value == nil { | ||
| curr = nil | ||
| } | ||
|
|
||
| if *limit == 0 { | ||
| return curr, true | ||
| } | ||
| } | ||
|
|
||
| if *limit == 0 { | ||
| return c, true | ||
| } | ||
|
|
||
| // Delete the current node as well | ||
| if c.value != nil { | ||
| *limit-- | ||
| } | ||
| return nil, true | ||
| } | ||
|
|
||
| return curr, true | ||
| } | ||
|
|
||
| // ClearPrefix deletes all key-value pairs from the trie where the key starts with the given prefix | ||
| func (t *Trie) ClearPrefix(prefix []byte) { | ||
| if len(prefix) == 0 { | ||
|
|
@@ -611,10 +738,10 @@ func (t *Trie) delete(parent node, key []byte) (node, bool) { | |
| // Key doesn't exist. | ||
| return p, false | ||
| case nil: | ||
| return nil, false | ||
| default: | ||
| panic(fmt.Sprintf("%T: invalid node: %v (%v)", p, p, key)) | ||
| } | ||
| } | ||
|
|
||
| // handleDeletion is called when a value is deleted from a branch | ||
|
|
||
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.
can you update this to reference a specific commit?
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.
Done