Parallel event reader #12554
Merged
Parallel event reader #12554
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
Implement `EventReader::par_read()` returning `EventParIter`. Currently the only operator implemented is `for_each`.
yyogo
commented
Mar 18, 2024
Comment on lines
+441
to
+470
| /// ``` | ||
| /// # use bevy_ecs::prelude::*; | ||
| /// # use std::sync::atomic::{AtomicUsize, Ordering}; | ||
| /// | ||
| /// #[derive(Event)] | ||
| /// struct MyEvent { | ||
| /// value: usize, | ||
| /// } | ||
| /// | ||
| /// #[derive(Resource, Default)] | ||
| /// struct Counter(AtomicUsize); | ||
| /// | ||
| /// // setup | ||
| /// let mut world = World::new(); | ||
| /// world.init_resource::<Events<MyEvent>>(); | ||
| /// world.insert_resource(Counter::default()); | ||
| /// | ||
| /// let mut schedule = Schedule::default(); | ||
| /// schedule.add_systems(|mut events: EventReader<MyEvent>, counter: Res<Counter>| { | ||
| /// events.par_read().for_each(|MyEvent { value }| { | ||
| /// counter.0.fetch_add(*value, Ordering::Relaxed); | ||
| /// }); | ||
| /// }); | ||
| /// for value in 0..100 { | ||
| /// world.send_event(MyEvent { value }); | ||
| /// } | ||
| /// schedule.run(&mut world); | ||
| /// let Counter(counter) = world.remove_resource::<Counter>().unwrap(); | ||
| /// // all events were processed | ||
| /// assert_eq!(counter.into_inner(), 4950); |
There was a problem hiding this comment.
The example is a bit contrived
yyogo
force-pushed
the
parallel-event-reader
branch
from
f818e29
to
9ae50b4
Compare
james7132
reviewed
Mar 18, 2024
james7132
added
C-Enhancement
Also document that event IDs are increasing by send order. This is already implied due to the `Ord` trait impl.
Encapsulate the batch size calculation logic in `BatchingStrategy`
yyogo
force-pushed
the
parallel-event-reader
branch
from
e890449
to
843aecf
Compare
james7132
reviewed
Mar 23, 2024
james7132
approved these changes
Mar 23, 2024
Co-authored-by: James Liu <contact@jamessliu.com>
pablo-lua
approved these changes
Apr 16, 2024
pablo-lua
added
the
S-Ready-For-Final-Review
Co-authored-by: Pablo Reinhardt <126117294+pablo-lua@users.noreply.github.com>
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
Allow parallel iteration over events, resolve #10766
Solution
EventParIterwhich works similarly toQueryParIter, implementing afor_each{_with_id}operator.I chose to not mirror
EventIteratorWithIdand instead implement both operations on a single struct.BatchingStrategyfromQueryParIterChangelog
EventReadernow supports parallel event iteration usingpar_read().for_each(|event| ...).