Return shallow copy of validator set in platformVM's validator manager #3512
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
StephenButtolph
added
bug
| @@ -230,7 +231,7 @@ func (m *manager) GetValidatorSet( | |||
| m.metrics.IncValidatorSetsCreated() | |||
| m.metrics.AddValidatorSetsDuration(duration) | |||
| m.metrics.AddValidatorSetsHeightDiff(currentHeight - targetHeight) | |||
| return validatorSet, nil | |||
| return maps.Clone(validatorSet), nil | |||
There was a problem hiding this comment.
I think the issue also comes from L203
PlatformVM's manager returns validators as a map, and caches the same instance. Then, it might be that different goroutines try to access this map instance concurrently, which is not safe. This commit simply shallow clones the map when returning it from within the validator manager. Signed-off-by: Yacov Manevich <yacov.manevich@avalabs.org>
yacovm
force-pushed
the
shallowCloneGetValidatorSet
branch
from
1fe07eb to
cf74836
Compare
StephenButtolph
approved these changes
Nov 1, 2024
marun
approved these changes
Nov 3, 2024
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.
Why this should be merged
PlatformVM's manager returns validators as a map, and caches the same instance. Then, it might be that different goroutines try to access this map instance concurrently, which is not safe and causes a data race.
How this works
This commit simply shallow clones the map when returning it from within the validator manager.
How this was tested
CI
Need to be documented in RELEASES.md?
No