Fixes a bug that caused concurrent field access of cloned, read-only structs with more than 5 members to be non-deterministic. #630
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
…structs with more than 5 members to be non-deterministic.
desaikd
approved these changes
Nov 1, 2023
zslayton
approved these changes
Nov 1, 2023
| @Override | ||
| public void makeReadOnly() { | ||
| // Eagerly initialize the fields map to prevent potential data races https://github.com/amazon-ion/ion-java/issues/629 | ||
| fieldMapIsActive(_child_count); |
There was a problem hiding this comment.
This name reads like a Boolean accessor.
popematt
approved these changes
Nov 1, 2023
| @@ -261,6 +266,30 @@ public void modifyAfterCloneDoesNotChangeOriginal() { | |||
| assertNotEquals(original, clone); | |||
| } | |||
|
|
|||
| @Test | |||
| public void readOnlyIonStructMultithreadedTest() { | |||
There was a problem hiding this comment.
suggestion—It would be nice to have a more descriptive name.
| @@ -101,6 +101,14 @@ private void build_field_map() | |||
| _field_map.put(v._fieldName, ii); // this causes the map to have the largest index value stored | |||
| } | |||
| } | |||
|
|
|||
| @Override | |||
| public void makeReadOnly() { | |||
There was a problem hiding this comment.
Is there a reason to only do this for IonStructLite as opposed to IonContainerLite?
There was a problem hiding this comment.
Do what, specifically? The field map is contained in IonStructLite.
There was a problem hiding this comment.
I was wondering if eager initialization is needed for IonContainerLite as well, but it seems the issue is isolated to IonStructLite
Codecov ReportAll modified and coverable lines are covered by tests ✅
... and 1 file with indirect coverage changes 📢 Thoughts on this report? Let us know!. |
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.
Issue #, if available:
Closes #629
Description of changes:
The
build_field_map()method assigns an empty map to the_fields_mapfield, and then populates it. This can result in a race condition where the fields map is active (i.e. not null) before it is actually populated. This change ensures that the field map, if required, is initialized and populated before the struct is made read-only, making it available for concurrent access from multiple threads.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.