Skip to content

Commit

Permalink
Bubble sync points if ignore_deferred, do not ignore if target syst…
Browse files Browse the repository at this point in the history 
…em is exclusive (#17880)

# Objective

Fixes #17828

This fixes two bugs:

1. Exclusive systems should see the effect of all commands queued to
that point. That does not happen when the system is configured with
`*_ignore_deferred` which may lead to surprising situations. These
configurations should not behave like that.
2. If `*_ignore_deferred` is used, no sync point may be added at all
**after** the config. Currently this can happen if the last nodes in
that config have no deferred parameters themselves. Instead, sync points
should always be added after such a config, so long systems have
deferred parameters.

## Solution

1. When adding sync points on edges, do not consider
`AutoInsertApplyDeferredPass::no_sync_edges` if the target is an
exclusive system.
2. when going through the nodes in a directed way, store the information
that `AutoInsertApplyDeferredPass::no_sync_edges` suppressed adding a
sync point at the target node. Then, when the target node is evaluated
later by the iteration and that prior suppression was the case, the
target node will behave like it has deferred parameters even if the
system itself does not.

## Testing

I added a test for each bug, please let me know if more are wanted and
if yes, which cases you would want to see.
These tests also can be read as examples how the current code would
fail.
  • Loading branch information
@urben1680
urben1680 authored Feb 26, 2025
1 parent c753107 commit 2f38464
Show file tree
Hide file tree
Showing 2 changed files with 125 additions and 45 deletions.
113 changes: 68 additions & 45 deletions crates/bevy_ecs/src/schedule/auto_insert_apply_deferred.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,71 +99,92 @@ impl ScheduleBuildPass for AutoInsertApplyDeferredPass {
.any(|(parent, _)| set_has_conditions(graph, parent))
}

let mut system_has_conditions_cache = HashMap::default();

fn is_valid_explicit_sync_point(
graph: &ScheduleGraph,
system: NodeId,
system_has_conditions_cache: &mut HashMap<usize, bool>,
) -> bool {
let mut system_has_conditions_cache = HashMap::<usize, bool>::default();
let mut is_valid_explicit_sync_point = |system: NodeId| {
let index = system.index();
is_apply_deferred(graph.systems[index].get().unwrap())
&& !*system_has_conditions_cache
.entry(index)
.or_insert_with(|| system_has_conditions(graph, system))
}
};

// calculate the number of sync points each sync point is from the beginning of the graph
let mut distances: HashMap<usize, u32> =
// Calculate the distance for each node.
// The "distance" is the number of sync points between a node and the beginning of the graph.
// Also store if a preceding edge would have added a sync point but was ignored to add it at
// a later edge that is not ignored.
let mut distances_and_pending_sync: HashMap<usize, (u32, bool)> =
HashMap::with_capacity_and_hasher(topo.len(), Default::default());

// Keep track of any explicit sync nodes for a specific distance.
let mut distance_to_explicit_sync_node: HashMap<u32, NodeId> = HashMap::default();

// Determine the distance for every node and collect the explicit sync points.
for node in &topo {
let node_system = graph.systems[node.index()].get().unwrap();

let node_needs_sync =
if is_valid_explicit_sync_point(graph, *node, &mut system_has_conditions_cache) {
distance_to_explicit_sync_node.insert(
distances.get(&node.index()).copied().unwrap_or_default(),
*node,
);

// This node just did a sync, so the only reason to do another sync is if one was
// explicitly scheduled afterwards.
false
} else {
node_system.has_deferred()
};
let (node_distance, mut node_needs_sync) = distances_and_pending_sync
.get(&node.index())
.copied()
.unwrap_or_default();

if is_valid_explicit_sync_point(*node) {
// The distance of this sync point does not change anymore as the iteration order
// makes sure that this node is no unvisited target of another node.
// Because of this, the sync point can be stored for this distance to be reused as
// automatically added sync points later.
distance_to_explicit_sync_node.insert(node_distance, *node);

// This node just did a sync, so the only reason to do another sync is if one was
// explicitly scheduled afterwards.
node_needs_sync = false;
} else if !node_needs_sync {
// No previous node has postponed sync points to add so check if the system itself
// has deferred params that require a sync point to apply them.
node_needs_sync = graph.systems[node.index()].get().unwrap().has_deferred();
}

for target in dependency_flattened.neighbors_directed(*node, Direction::Outgoing) {
let edge_needs_sync = node_needs_sync
&& !self.no_sync_edges.contains(&(*node, target))
|| is_valid_explicit_sync_point(
graph,
target,
&mut system_has_conditions_cache,
);

let weight = if edge_needs_sync { 1 } else { 0 };

// Use whichever distance is larger, either the current distance, or the distance to
// the parent plus the weight.
let distance = distances
.get(&target.index())
.copied()
.unwrap_or_default()
.max(distances.get(&node.index()).copied().unwrap_or_default() + weight);
let (target_distance, target_pending_sync) = distances_and_pending_sync
.entry(target.index())
.or_default();

let mut edge_needs_sync = node_needs_sync;
if node_needs_sync
&& !graph.systems[target.index()].get().unwrap().is_exclusive()
&& self.no_sync_edges.contains(&(*node, target))
{
// The node has deferred params to apply, but this edge is ignoring sync points.
// Mark the target as 'delaying' those commands to a future edge and the current
// edge as not needing a sync point.
*target_pending_sync = true;
edge_needs_sync = false;
}

distances.insert(target.index(), distance);
let mut weight = 0;
if edge_needs_sync || is_valid_explicit_sync_point(target) {
// The target distance grows if a sync point is added between it and the node.
// Also raise the distance if the target is a sync point itself so it then again
// raises the distance of following nodes as that is what the distance is about.
weight = 1;
}

// The target cannot have fewer sync points in front of it than the preceding node.
*target_distance = (node_distance + weight).max(*target_distance);
}
}

// Find any edges which have a different number of sync points between them and make sure
// there is a sync point between them.
for node in &topo {
let node_distance = distances.get(&node.index()).copied().unwrap_or_default();
let (node_distance, _) = distances_and_pending_sync
.get(&node.index())
.copied()
.unwrap_or_default();

for target in dependency_flattened.neighbors_directed(*node, Direction::Outgoing) {
let target_distance = distances.get(&target.index()).copied().unwrap_or_default();
let (target_distance, _) = distances_and_pending_sync
.get(&target.index())
.copied()
.unwrap_or_default();

if node_distance == target_distance {
// These nodes are the same distance, so they don't need an edge between them.
continue;
Expand All @@ -174,6 +195,7 @@ impl ScheduleBuildPass for AutoInsertApplyDeferredPass {
// already!
continue;
}

let sync_point = distance_to_explicit_sync_node
.get(&target_distance)
.copied()
Expand All @@ -182,6 +204,7 @@ impl ScheduleBuildPass for AutoInsertApplyDeferredPass {
sync_point_graph.add_edge(*node, sync_point);
sync_point_graph.add_edge(sync_point, target);

// The edge without the sync point is now redundant.
sync_point_graph.remove_edge(*node, target);
}
}
Expand Down
57 changes: 57 additions & 0 deletions crates/bevy_ecs/src/schedule/schedule.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2262,6 +2262,63 @@ mod tests {
assert_eq!(schedule.executable.systems.len(), 5);
}

#[test]
fn do_not_consider_ignore_deferred_before_exclusive_system() {
let mut schedule = Schedule::default();
let mut world = World::default();
// chain_ignore_deferred adds no sync points usually but an exception is made for exclusive systems
schedule.add_systems(
(
|_: Commands| {},
// <- no sync point is added here because the following system is not exclusive
|mut commands: Commands| commands.insert_resource(Resource1),
// <- sync point is added here because the following system is exclusive which expects to see all commands to that point
|world: &mut World| assert!(world.contains_resource::<Resource1>()),
// <- no sync point is added here because the previous system has no deferred parameters
|_: &mut World| {},
// <- no sync point is added here because the following system is not exclusive
|_: Commands| {},
)
.chain_ignore_deferred(),
);
schedule.run(&mut world);

assert_eq!(schedule.executable.systems.len(), 6); // 5 systems + 1 sync point
}

#[test]
fn bubble_sync_point_through_ignore_deferred_node() {
let mut schedule = Schedule::default();
let mut world = World::default();

let insert_resource_config = (
// the first system has deferred commands
|mut commands: Commands| commands.insert_resource(Resource1),
// the second system has no deferred commands
|| {},
)
// the first two systems are chained without a sync point in between
.chain_ignore_deferred();

schedule.add_systems(
(
insert_resource_config,
// the third system would panic if the command of the first system was not applied
|_: Res<Resource1>| {},
)
// the third system is chained after the first two, possibly with a sync point in between
.chain(),
);

// To add a sync point between the second and third system despite the second having no commands,
// the first system has to signal the second system that there are unapplied commands.
// With that the second system will add a sync point after it so the third system will find the resource.

schedule.run(&mut world);

assert_eq!(schedule.executable.systems.len(), 4); // 3 systems + 1 sync point
}

#[test]
fn disable_auto_sync_points() {
let mut schedule = Schedule::default();
Expand Down

0 comments on commit 2f38464

Please sign in to comment.