Fix unsoundness in QueryState::is_empty
#9463
Merged
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
alice-i-cecile
added
A-ECS
|
Example |
JoJoJet
changed the title
Query::is_empty safeQueryState::is_empty
JoJoJet
commented
Aug 19, 2023
soqb
approved these changes
Aug 21, 2023
|
I realized that the safety invariants were still a bit off (based on the incorrect assumption that |
JoJoJet
commented
Aug 22, 2023
JoJoJet
commented
Sep 2, 2023
alice-i-cecile
approved these changes
Sep 2, 2023
alice-i-cecile
added
the
S-Ready-For-Final-Review
rdrpenguin04
pushed a commit
to rdrpenguin04/bevy
that referenced
this pull request
Jan 9, 2024
# Objective `QueryState::is_empty` is unsound, as it does not validate the world. If a mismatched world is passed in, then the query filter may cast a component to an incorrect type, causing undefined behavior. ## Solution Add world validation. To prevent a performance regression in `Query` (whose world does not need to be validated), the unchecked function `is_empty_unsafe_world_cell` has been added. This also allows us to remove one of the last usages of the private function `UnsafeWorldCell::unsafe_world`, which takes us a step towards being able to remove that method entirely.
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.
Objective
QueryState::is_emptyis unsound, as it does not validate the world. If a mismatched world is passed in, then the query filter may cast a component to an incorrect type, causing undefined behavior.Solution
Add world validation. To prevent a performance regression in
Query(whose world does not need to be validated), the unchecked functionis_empty_unsafe_world_cellhas been added. This also allows us to remove one of the last usages of the private functionUnsafeWorldCell::unsafe_world, which takes us a step towards being able to remove that method entirely.